org.hps.record.triggerbank

Class AbstractIntData

java.lang.Object

org.hps.record.triggerbank.AbstractIntData

All Implemented Interfaces:

org.lcsim.event.GenericObject

Direct Known Subclasses:

HeadBankData, SSPData, TDCData, TestRunTriggerData, TIData

public abstract class AbstractIntData
extends Object
implements org.lcsim.event.GenericObject

Class GenericObject representation of an INT32/UINT32 bank read from EvIO. The bank header tag identifies the type of data, and is stored as the first int in the GenericObject. The contents of the bank are the remaining N-1 int primitives. Constructors are provided from int[] (for reading from EvIO) and from GenericObject (for reading from LCIO).

Subclasses must implement the two constructors and two abstract methods, plus whatever methods are needed to access the parsed data.

Author:

Sho Uemura

See Also:

GenericObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractIntData.IntBankDefinition Utility class used to search an EVIO event for a specified int bank.

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	bank The data bank.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIntData(org.lcsim.event.GenericObject data, int expectedTag) Create an AbstractIntData object from an LCIO genericObject.
protected	AbstractIntData(int[] bank) Constructs an AbstractIntData from a raw EvIO integer bank.

Method Summary

Modifier and Type	Method and Description
protected abstract void	decodeData() Parses the bank so the object can be used in analysis.
int[]	getBank() Gets the entire, unparsed integer data bank from the object.
static int[]	getBank(org.lcsim.event.GenericObject object) Return the int bank of an AbstractIntData read from LCIO.
static int	getBankInt(org.lcsim.event.GenericObject object, int index) Return a single value from the integer bank of an AbstractIntData.
double	getDoubleVal(int index)
float	getFloatVal(int index)
int	getIntVal(int index)
int	getNDouble()
int	getNFloat()
int	getNInt()
abstract int	getTag() Returns the EvIO bank header tag expected for this data.
static int	getTag(org.lcsim.event.GenericObject data) Returns the EVIO bank tag for a data object.
boolean	isFixedSize()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bank

protected int[] bank

The data bank.

Constructor Detail

AbstractIntData

protected AbstractIntData(int[] bank)

Constructs an AbstractIntData from a raw EvIO integer bank. It is expected that the EvIO reader will verify that the bank tag is the appropriate type before calling the constructor.

Parameters:

bank - - An EvIO bank of int data.

AbstractIntData

protected AbstractIntData(org.lcsim.event.GenericObject data,
                          int expectedTag)

Create an AbstractIntData object from an LCIO genericObject. Constructor requires that the GenericObject tag match the expected EvIO header tag type as defined by the implementing class.

Parameters:

data - - The source data bank.

expectedTag - - The required EvIO bank header tag.

Method Detail

getBank

public int[] getBank()

Gets the entire, unparsed integer data bank from the object.

Returns:

Returns the data as an int[] array.

getBank

public static int[] getBank(org.lcsim.event.GenericObject object)

Return the int bank of an AbstractIntData read from LCIO.

Parameters:

object -

getBankInt

public static int getBankInt(org.lcsim.event.GenericObject object,
                             int index)

Return a single value from the integer bank of an AbstractIntData.

Parameters:

object - - The bank from which to obtain the data.

index - - The index of the data in the bank.

Returns:

Returns the requested entry from the integer bank.

getTag

public abstract int getTag()

Returns the EvIO bank header tag expected for this data.

Returns:

Returns the tag as an int primitive.

getTag

public static int getTag(org.lcsim.event.GenericObject data)

Returns the EVIO bank tag for a data object.

Parameters:

data - - A GenericObject representing an integer data bank.

Returns:

Returns the EvIO tag identifying the type of bank the object represents.

decodeData

protected abstract void decodeData()

Parses the bank so the object can be used in analysis.

getNInt

public int getNInt()

Specified by:

getNInt in interface org.lcsim.event.GenericObject

getNFloat

public int getNFloat()

Specified by:

getNFloat in interface org.lcsim.event.GenericObject

getNDouble

public int getNDouble()

Specified by:

getNDouble in interface org.lcsim.event.GenericObject

getIntVal

public int getIntVal(int index)

Specified by:

getIntVal in interface org.lcsim.event.GenericObject

getFloatVal

public float getFloatVal(int index)

Specified by:

getFloatVal in interface org.lcsim.event.GenericObject

getDoubleVal

public double getDoubleVal(int index)

Specified by:

getDoubleVal in interface org.lcsim.event.GenericObject

isFixedSize

public boolean isFixedSize()

Specified by:

isFixedSize in interface org.lcsim.event.GenericObject