LCIO API
Version v02-04

hep.lcio.event
Interface LCGenericObject

All Superinterfaces:
java.lang.Cloneable, LCObject
All Known Implementing Classes:
CalibrationConstant, ILCGenericObject

public interface LCGenericObject
extends LCObject

Simple interface to store generic user data. To store your own classes they have to implement this interface.

Version:
$Id: LCGenericObject.aid,v 1.7 2006-08-04 16:52:44 gaede Exp $
Author:
gaede

Method Summary
 java.lang.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.
 java.lang.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.
 

Method Detail

getNInt

int getNInt()
Number of integer values stored in this object.


getNFloat

int getNFloat()
Number of float values stored in this object.


getNDouble

int getNDouble()
Number of double values stored in this object.


getIntVal

int getIntVal(int index)
Returns the integer value for the given index.


getFloatVal

float getFloatVal(int index)
Returns the float value for the given index.


getDoubleVal

double getDoubleVal(int index)
Returns the double value for the given index.


isFixedSize

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.


getTypeName

java.lang.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.


getDataDescription

java.lang.String getDataDescription()
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".


LCIO API
Version v02-04

Copyright © 2002-2003 LCIO Team, All Rights Reserved.