org.lcsim.event.base

Class BaseLCSimEvent.MetaData

java.lang.Object

org.lcsim.event.base.BaseLCSimEvent.MetaData

All Implemented Interfaces:

EventHeader.LCMetaData

Enclosing class:

BaseLCSimEvent

private class BaseLCSimEvent.MetaData
extends Object
implements EventHeader.LCMetaData

Field Summary

Fields

Modifier and Type	Field and Description
private IDDecoder	dec
private int	flags
private Map<String,float[]>	floatMap
private Map<String,int[]>	intMap
private String	name
private Map<String,String[]>	stringMap
private Class	type

Constructor Summary

Constructors

Constructor and Description
BaseLCSimEvent.MetaData(String name, Class type, int flags, Map intMap, Map floatMap, Map stringMap)
BaseLCSimEvent.MetaData(String name, Class type, int flags, String readoutName)

Method Summary

Methods

Modifier and Type	Method and Description
private IDDecoder	createIDDecoderFromCellIDEncoding() Make an IDDecoder for this MetaData using the CellIDEncoding parameter.
IDDecoder	findIDDecoder()
EventHeader	getEvent() Get the event with which this meta-data is associated.
int	getFlags() The LCIO flags stored with the associated data collection.
Map<String,float[]>	getFloatParameters()
IDDecoder	getIDDecoder() An IDDecoder that can be used to decode the ID's stored in this data collection.
Map<String,int[]>	getIntegerParameters()
String	getName() The name of the associated data collection
Map<String,String[]>	getStringParameters()
Class	getType() The type of objects stored in the associated data collection.
boolean	isSubset()
boolean	isTransient()
void	setSubset(boolean isSubset) Flag whether the collection associated with this meta-data is a subset of some other collection.
void	setTransient(boolean isTransient) Flag whether the collection associated with this meta-data should be treated as transient.

Methods inherited from class java.lang.Object

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

Field Detail

dec

private transient IDDecoder dec

flags

private int flags

floatMap

private Map<String,float[]> floatMap

intMap

private Map<String,int[]> intMap

name

private final String name

stringMap

private Map<String,String[]> stringMap

type

private final Class type

Constructor Detail

BaseLCSimEvent.MetaData

BaseLCSimEvent.MetaData(String name,
                       Class type,
                       int flags,
                       Map intMap,
                       Map floatMap,
                       Map stringMap)

BaseLCSimEvent.MetaData

BaseLCSimEvent.MetaData(String name,
                       Class type,
                       int flags,
                       String readoutName)

Method Detail

createIDDecoderFromCellIDEncoding

private IDDecoder createIDDecoderFromCellIDEncoding()

Make an IDDecoder for this MetaData using the CellIDEncoding parameter.

Returns:

An IDDecoder made built from the CellIDEncoding.

findIDDecoder

public IDDecoder findIDDecoder()

getEvent

public EventHeader getEvent()

Description copied from interface: EventHeader.LCMetaData

Get the event with which this meta-data is associated.

Specified by:

getEvent in interface EventHeader.LCMetaData

getFlags

public int getFlags()

Description copied from interface: EventHeader.LCMetaData

The LCIO flags stored with the associated data collection.

Specified by:

getFlags in interface EventHeader.LCMetaData

getFloatParameters

public Map<String,float[]> getFloatParameters()

Specified by:

getFloatParameters in interface EventHeader.LCMetaData

getIDDecoder

public IDDecoder getIDDecoder()

Description copied from interface: EventHeader.LCMetaData

An IDDecoder that can be used to decode the ID's stored in this data collection. Primarily used for calorimeter and tracker hits.

Specified by:

getIDDecoder in interface EventHeader.LCMetaData

getIntegerParameters

public Map<String,int[]> getIntegerParameters()

Specified by:

getIntegerParameters in interface EventHeader.LCMetaData

getName

public String getName()

Description copied from interface: EventHeader.LCMetaData

The name of the associated data collection

Specified by:

getName in interface EventHeader.LCMetaData

getStringParameters

public Map<String,String[]> getStringParameters()

Specified by:

getStringParameters in interface EventHeader.LCMetaData

getType

public Class getType()

Description copied from interface: EventHeader.LCMetaData

The type of objects stored in the associated data collection.

Specified by:

getType in interface EventHeader.LCMetaData

isSubset

public boolean isSubset()

Specified by:

isSubset in interface EventHeader.LCMetaData

isTransient

public boolean isTransient()

Specified by:

isTransient in interface EventHeader.LCMetaData

setSubset

public void setSubset(boolean isSubset)

Description copied from interface: EventHeader.LCMetaData

Flag whether the collection associated with this meta-data is a subset of some other collection. When flagged in this way the collection will be written to an LCIO file as a reference collection, ie as a set of pointers to objects in the master collection.

Specified by:

setSubset in interface EventHeader.LCMetaData

setTransient

public void setTransient(boolean isTransient)

Description copied from interface: EventHeader.LCMetaData

Flag whether the collection associated with this meta-data should be treated as transient. Transient collections are never written out to LCIO files.

Specified by:

setTransient in interface EventHeader.LCMetaData