hep.lcio.event

Interface LCCollection

All Superinterfaces:

Collection, Iterable, List

All Known Implementing Classes:

ILCCollection

public interface LCCollection
extends List

The generic collection used in LCIO. Holds arbitrary objects of type LCObject.

See Also:

LCObject, LCIO

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITDefault
static int	BITSubset
static int	BITTransient Transient bit in flag word.

Method Summary

Modifier and Type	Method and Description
void	addElement(LCObject obj) Adds the given element to (end of) the collection.
LCObject	getElementAt(int index) Returns pointer to element at index - no range check, use getNumberOfEntries().
int	getFlag() Returns flag word for collection.
int	getNumberOfElements() Returns the number of elements in the collection.
LCParameters	getParameters() Parameters defined for this collection.
String	getTypeName() Returns the type name of the collection - valid names are defined in LCIO.
boolean	isDefault() True if collection is the default collection for the given type.
boolean	isSubset() True if the collection holds a subset of objects from other collections.
boolean	isTransient() True if collection is transient, i.e.
void	removeElementAt(int i) Removes the i-th element from the collection.
void	setFlag(int flag) Set the flag word.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

BITTransient

static final int BITTransient

Transient bit in flag word.

See Also:

Constant Field Values

BITDefault

static final int BITDefault

See Also:

Constant Field Values

BITSubset

static final int BITSubset

See Also:

Constant Field Values

Method Detail

getNumberOfElements

int getNumberOfElements()

Returns the number of elements in the collection. Same as size().

getTypeName

String getTypeName()

Returns the type name of the collection - valid names are defined in LCIO.

getElementAt

LCObject getElementAt(int index)

Returns pointer to element at index - no range check, use getNumberOfEntries().

getFlag

int getFlag()

Returns flag word for collection. Bits 16-31 are reserved for LCIO Depending on the object type stored they have a special meaning, e.g. for SimCalorimeterHits:
CHBIT_LONG = 31 - store position
CHBIT_BARREL = 30 - endcap or barrel
CHBIT_ID1 = 29 - cellid1 is sored
CHBIT_PDG = 28 - store pdg of secondaries

Bit 16 is used to flag collection as transient
Bit 17 is used to flag collection as default
Bit 18 is used to flag collection as subset
Bits 0-15 are subdetector/user specific.

See Also:

isTransient()

isTransient

boolean isTransient()

True if collection is transient, i.e. will not be written to any LCIO file. Convenient method that checks bit BITTransient of the flag word.

isDefault

boolean isDefault()

True if collection is the default collection for the given type. This implies that the collection is complete and unambigous. Convenient method that checks bit BITDefault of the flag word.

isSubset

boolean isSubset()

True if the collection holds a subset of objects from other collections. If the collection is not transient only the pointers/references to the original objects will be stored. Convenient method that checks bit BITSubset of the flag word.

addElement

void addElement(LCObject obj)
         throws ReadOnlyException

Adds the given element to (end of) the collection. Throws an exception if the collection (event) is 'read only'.

Throws:

ReadOnlyException

removeElementAt

void removeElementAt(int i)
              throws ReadOnlyException

Removes the i-th element from the collection. Throws an exception if the collection (event) is 'read only'.

Throws:

ReadOnlyException

setFlag

void setFlag(int flag)

Set the flag word. This is allowed in 'read only' mode.

getParameters

LCParameters getParameters()

Parameters defined for this collection.