hep.lcio.implementation.event

Class ILCCollection

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList

hep.lcio.implementation.event.ILCCollection

All Implemented Interfaces:

LCCollection, Serializable, Cloneable, Iterable, Collection, List, RandomAccess

public class ILCCollection
extends ArrayList
implements LCCollection

A default implementation of LCCollection

See Also:

Serialized Form

Field Summary

Fields inherited from interface hep.lcio.event.LCCollection

BITDefault, BITSubset, BITTransient

Constructor Summary

Constructors

Constructor and Description
ILCCollection(String type)
ILCCollection(String type, int flag, int size)

Method Summary

Modifier and Type	Method and Description
void	add(LCObject object)
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	setDefault()
void	setDefault(boolean val)
void	setFlag(int flag) Set the flag word.
void	setParameters(LCParameters p)
void	setSubset()
void	setSubset(boolean val)
void	setTransient()
void	setTransient(boolean val)

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

Constructor Detail

ILCCollection

public ILCCollection(String type)

ILCCollection

public ILCCollection(String type,
                     int flag,
                     int size)

Method Detail

getElementAt

public LCObject getElementAt(int index)

Description copied from interface: LCCollection

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

Specified by:

getElementAt in interface LCCollection

setFlag

public void setFlag(int flag)

Description copied from interface: LCCollection

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

Specified by:

setFlag in interface LCCollection

getFlag

public int getFlag()

Description copied from interface: LCCollection

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.

Specified by:

getFlag in interface LCCollection

See Also:

LCCollection.isTransient()

getNumberOfElements

public int getNumberOfElements()

Description copied from interface: LCCollection

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

Specified by:

getNumberOfElements in interface LCCollection

getTypeName

public String getTypeName()

Description copied from interface: LCCollection

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

Specified by:

getTypeName in interface LCCollection

add

public void add(LCObject object)

addElement

public void addElement(LCObject obj)
                throws ReadOnlyException

Description copied from interface: LCCollection

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

Specified by:

addElement in interface LCCollection

Throws:

ReadOnlyException

removeElementAt

public void removeElementAt(int i)
                     throws ReadOnlyException

Description copied from interface: LCCollection

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

Specified by:

removeElementAt in interface LCCollection

Throws:

ReadOnlyException

getParameters

public LCParameters getParameters()

Description copied from interface: LCCollection

Parameters defined for this collection.

Specified by:

getParameters in interface LCCollection

setParameters

public void setParameters(LCParameters p)

isTransient

public boolean isTransient()

Description copied from interface: LCCollection

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.

Specified by:

isTransient in interface LCCollection

setTransient

public void setTransient()

setTransient

public void setTransient(boolean val)

isDefault

public boolean isDefault()

Description copied from interface: LCCollection

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.

Specified by:

isDefault in interface LCCollection

setDefault

public void setDefault()

setDefault

public void setDefault(boolean val)

isSubset

public boolean isSubset()

Description copied from interface: LCCollection

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.

Specified by:

isSubset in interface LCCollection

setSubset

public void setSubset()

setSubset

public void setSubset(boolean val)