org.lcsim.event

Interface EventHeader

All Superinterfaces:

HEPEvent, MCEvent

All Known Implementing Classes:

BaseLCSimEvent, LCIOEvent

public interface EventHeader
extends MCEvent

The event header from which information about the rest of the event can be obtained.

Version:

$Id: EventHeader.java,v 1.23 2012/07/02 21:50:17 jeremy Exp $

Author:

Tony Johnson

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EventHeader.LCMetaData List of elements stored in the event may have meta-data associated with them.

Field Summary

Fields inherited from interface hep.physics.event.generator.MCEvent

MC_PARTICLES

Method Summary

Methods

Modifier and Type	Method and Description
<T> List<List<T>>	get(Class<T> type) Get a collection of data from the event.
<T> List<T>	get(Class<T> type, String name) Obtain a collection of objects associated with this event, specified by type and name.
Detector	getDetector() Get the detector description read from the conditions database
String	getDetectorName() The name of the detector, used to obtain geometry and conditions.
Map<String,float[]>	getFloatParameters()
Map<String,int[]>	getIntegerParameters()
Set<List>	getLists() Get all the lists associated with this event.
List<MCParticle>	getMCParticles() Get the list of MC particles associated with this event.
Collection<EventHeader.LCMetaData>	getMetaData() Get all the meta data associated with this event.
EventHeader.LCMetaData	getMetaData(List x) Get the meta data associated with a list obtained from this event.
Map<String,String[]>	getStringParameters()
long	getTimeStamp() The creation time of this event (in nS since 1-Jan-1970 GMT).
float	getWeight() Get the event weight
boolean	hasCollection(Class type) Test if the event contains at least one collection of the given type.
boolean	hasCollection(Class type, String collection) Test if the event contains a collection of a given type and name.
boolean	hasItem(String name) Test if the event contains a given item.
void	put(String name, List collection, Class type, int flags) Add a collection to the event.
void	put(String name, List collection, Class type, int flags, Map intMap, Map floatMap, Map stringMap)
void	put(String name, List collection, Class type, int flags, String readoutName) Add a collection to the event.
void	remove(String name) Removes an item from the event

Methods inherited from interface hep.physics.event.HEPEvent

get, getEventNumber, getRunNumber, getTags, keys, put

Method Detail

getMCParticles

List<MCParticle> getMCParticles()

Get the list of MC particles associated with this event.

Specified by:

getMCParticles in interface MCEvent

get

<T> List<List<T>> get(Class<T> type)

Get a collection of data from the event. This method will throw IllegalArgumentException if the requested data is not found.

Parameters:

type - The type of object requested.

Returns:

The collection of data.

get

<T> List<T> get(Class<T> type,
              String name)

Obtain a collection of objects associated with this event, specified by type and name. This method will throw IllegalArgumentException if the requested data is not found.

Parameters:

type - The class of items stored in the requested collection

name - The name of the requested collection

Returns:

The resulting collection.

getMetaData

EventHeader.LCMetaData getMetaData(List x)

Get the meta data associated with a list obtained from this event.

getMetaData

Collection<EventHeader.LCMetaData> getMetaData()

Get all the meta data associated with this event.

Returns:

A Collection of LCMetaData objects associated with this event.

getLists

Set<List> getLists()

Get all the lists associated with this event.

Returns:

A Set of List objects associated with this event.

getDetectorName

String getDetectorName()

The name of the detector, used to obtain geometry and conditions.

getTimeStamp

long getTimeStamp()

The creation time of this event (in nS since 1-Jan-1970 GMT).

Specified by:

getTimeStamp in interface HEPEvent

getDetector

Detector getDetector()

Get the detector description read from the conditions database

put

void put(String name,
       List collection,
       Class type,
       int flags)

Add a collection to the event.

Parameters:

name - The name used to stored this collection in the event.

collection - The data collection

type - The class of objects stored in the collection.

flags - The LCIO flags associated with the collection.

put

void put(String name,
       List collection,
       Class type,
       int flags,
       String readoutName)

Add a collection to the event.

Parameters:

name - The name used to stored this collection in the event.

collection - The data collection

type - The class of objects stored in the collection.

flags - The LCIO flags associated with the collection.

readoutName - The name of the readout to be used to decode hits in this collection

put

void put(String name,
       List collection,
       Class type,
       int flags,
       Map intMap,
       Map floatMap,
       Map stringMap)

Parameters:

name -

collection -

type -

flags -

intMap -

floatMap -

stringMap -

remove

void remove(String name)

Removes an item from the event

hasCollection

boolean hasCollection(Class type,
                    String collection)

Test if the event contains a collection of a given type and name. Can be used to avoid having to catch an exception if the event does not contain an expected collection when calling get.

hasCollection

boolean hasCollection(Class type)

Test if the event contains at least one collection of the given type.

hasItem

boolean hasItem(String name)

Test if the event contains a given item.

Parameters:

name - The name of the item to look for

Returns:

true if the event contains an item with the given name.

getWeight

float getWeight()

Get the event weight

Returns:

The weight

getIntegerParameters

Map<String,int[]> getIntegerParameters()

getFloatParameters

Map<String,float[]> getFloatParameters()

getStringParameters

Map<String,String[]> getStringParameters()