hep.lcio.implementation.event

Class ILCEvent

java.lang.Object

hep.lcio.implementation.event.ILCEvent

All Implemented Interfaces:

LCEvent

Direct Known Subclasses:

RandomEvent

public class ILCEvent
extends Object
implements LCEvent

A default implementation of LCEvent

Constructor Summary

Constructors

Constructor and Description
ILCEvent()

Method Summary

Modifier and Type	Method and Description
void	addCollection(LCCollection col, String name) Adds a collection with the given name (has to be a valid C/C++ variable name).
LCCollection	getCollection(String name) Returns the collection for the given name.
LCCollection	getCollectionData(String name)
String[]	getCollectionNames() Returns the names of the collections in the event.
String	getDetectorName() Returns the name of the detector setup used in the simulation.
int	getEventNumber() Returns this event's number .
LCParameters	getParameters() Parameters defined for this event.
int	getRunNumber() Return the run number off this event.
long	getTimeStamp() Returns the time stamp of the event.
double	getWeight() Returns the event weight.
void	removeCollection(String name) Removes (and deletes) the collection with name (if it exists in the event).
void	setDetectorName(String detectorName)
void	setEventNumber(int event)
void	setRunNumber(int run)
void	setTimeStamp(long timeStamp)
void	setWeight(double w)

Methods inherited from class java.lang.Object

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

Constructor Detail

ILCEvent

public ILCEvent()

Method Detail

getCollection

public LCCollection getCollection(String name)
                           throws DataNotAvailableException

Description copied from interface: LCEvent

Returns the collection for the given name.

Specified by:

getCollection in interface LCEvent

Throws:

DataNotAvailableException

getCollectionData

public LCCollection getCollectionData(String name)

getCollectionNames

public String[] getCollectionNames()

Description copied from interface: LCEvent

Returns the names of the collections in the event.

Specified by:

getCollectionNames in interface LCEvent

setDetectorName

public void setDetectorName(String detectorName)

getDetectorName

public String getDetectorName()

Description copied from interface: LCEvent

Returns the name of the detector setup used in the simulation.

Specified by:

getDetectorName in interface LCEvent

setEventNumber

public void setEventNumber(int event)

getEventNumber

public int getEventNumber()

Description copied from interface: LCEvent

Returns this event's number .

Specified by:

getEventNumber in interface LCEvent

setRunNumber

public void setRunNumber(int run)

getRunNumber

public int getRunNumber()

Description copied from interface: LCEvent

Return the run number off this event.

Specified by:

getRunNumber in interface LCEvent

setTimeStamp

public void setTimeStamp(long timeStamp)

getTimeStamp

public long getTimeStamp()

Description copied from interface: LCEvent

Returns the time stamp of the event. Timestamp is a unique 64 bit integer.
Definition: ns since January 1, 1970, 00:00:00 GMT

Specified by:

getTimeStamp in interface LCEvent

getWeight

public double getWeight()

Description copied from interface: LCEvent

Returns the event weight.

Specified by:

getWeight in interface LCEvent

setWeight

public void setWeight(double w)

addCollection

public void addCollection(LCCollection col,
                          String name)

Description copied from interface: LCEvent

Adds a collection with the given name (has to be a valid C/C++ variable name). Throws an exception if the name already exists in the event. NB: Adding collections is allowed even when the event is 'read only'.

Specified by:

addCollection in interface LCEvent

See Also:

validateCollectionName

removeCollection

public void removeCollection(String name)

Description copied from interface: LCEvent

Removes (and deletes) the collection with name (if it exists in the event). Throws an exception if the event is 'read only' as defined by the read mode in LCReader.

Specified by:

removeCollection in interface LCEvent

getParameters

public LCParameters getParameters()

Description copied from interface: LCEvent

Parameters defined for this event.

Specified by:

getParameters in interface LCEvent