hep.lcio.event

Interface LCEvent

All Known Implementing Classes:

ILCEvent, RandomEvent

public interface LCEvent

The main event interface. Holds named collections with elements of type LCObject ('untyped'). Users have to cast to the corresponding types.

See Also:

LCCollection

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.
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).

Method Detail

getRunNumber

int getRunNumber()

Return the run number off this event.

getEventNumber

int getEventNumber()

Returns this event's number .

getDetectorName

String getDetectorName()

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

getTimeStamp

long getTimeStamp()

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

getWeight

double getWeight()

Returns the event weight.

getCollectionNames

String[] getCollectionNames()

Returns the names of the collections in the event.

getCollection

LCCollection getCollection(String name)
                    throws DataNotAvailableException

Returns the collection for the given name.

Throws:

DataNotAvailableException

addCollection

void addCollection(LCCollection col,
                   String name)
            throws EventException

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'.

Throws:

EventException

See Also:

validateCollectionName

removeCollection

void removeCollection(String name)
               throws ReadOnlyException

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.

Throws:

ReadOnlyException

getParameters

LCParameters getParameters()

Parameters defined for this event.