hep.lcio.example

Class CalibrationConstant

java.lang.Object

hep.lcio.example.CalibrationConstant

All Implemented Interfaces:

LCGenericObject, LCObject, Cloneable

public class CalibrationConstant
extends Object
implements LCGenericObject

Example for a user class based on LCGenericObject.
Note: Once we switch to Java 1.5 we can provide a templated class for fixed size LCGenericObjects that makes it easier for the users to implement their classes.

Constructor Summary

Constructors

Constructor and Description
CalibrationConstant(int cellId, float offset, float gain) Convenience c'tor
CalibrationConstant(LCObject obj) Convenience wrapper for LCGenericObjects read from file

Method Summary

Modifier and Type	Method and Description
String	getDataDescription() The description string.
double	getDoubleVal(int index) Returns the double value for the given index.
float	getFloatVal(int index) Returns the float value for the given index.
int	getIntVal(int index) Returns the integer value for the given index.
int	getNDouble() Number of double values stored in this object.
int	getNFloat() Number of float values stored in this object.
int	getNInt() Number of integer values stored in this object.
String	getTypeName() The type name of the user class (typically the class name) This type name is stored as a collection parameter "TypeName" with every collection of LCGenericObject subclasses.
boolean	isFixedSize() True if objects of the implementation class have a fixed size, i.e getNInt, getNFloat and getNDouble will return values that are constant during the lifetime of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalibrationConstant

public CalibrationConstant(int cellId,
                           float offset,
                           float gain)

Convenience c'tor

CalibrationConstant

public CalibrationConstant(LCObject obj)
                    throws Exception

Convenience wrapper for LCGenericObjects read from file

Throws:

Exception

Method Detail

getNInt

public int getNInt()

Description copied from interface: LCGenericObject

Number of integer values stored in this object.

Specified by:

getNInt in interface LCGenericObject

getNFloat

public int getNFloat()

Description copied from interface: LCGenericObject

Number of float values stored in this object.

Specified by:

getNFloat in interface LCGenericObject

getNDouble

public int getNDouble()

Description copied from interface: LCGenericObject

Number of double values stored in this object.

Specified by:

getNDouble in interface LCGenericObject

getIntVal

public int getIntVal(int index)

Description copied from interface: LCGenericObject

Returns the integer value for the given index.

Specified by:

getIntVal in interface LCGenericObject

getFloatVal

public float getFloatVal(int index)

Description copied from interface: LCGenericObject

Returns the float value for the given index.

Specified by:

getFloatVal in interface LCGenericObject

getDoubleVal

public double getDoubleVal(int index)

Description copied from interface: LCGenericObject

Returns the double value for the given index.

Specified by:

getDoubleVal in interface LCGenericObject

isFixedSize

public boolean isFixedSize()

Description copied from interface: LCGenericObject

True if objects of the implementation class have a fixed size, i.e getNInt, getNFloat and getNDouble will return values that are constant during the lifetime of the object.

Specified by:

isFixedSize in interface LCGenericObject

getTypeName

public String getTypeName()

Description copied from interface: LCGenericObject

The type name of the user class (typically the class name) This type name is stored as a collection parameter "TypeName" with every collection of LCGenericObject subclasses.

Specified by:

getTypeName in interface LCGenericObject

getDataDescription

public String getDataDescription()

Description copied from interface: LCGenericObject

The description string. A comma separated list of pairs of type identifier, one of 'i','f','d' followed by ':' and an attribute name, e.g. "i:cellId,f:offset,f:gain".

Specified by:

getDataDescription in interface LCGenericObject