Utility class for storing an event summary as an LCGenericObject. More...

#include <EventSummary.h>

Inheritance diagram for UTIL::EventSummary:

Public Member Functions
	EventSummary ()=default
	Convenient c'tor. More...

	EventSummary (LCObject *o)
	'Copy constructor' needed to interpret LCCollection read from file/database. More...

virtual	~EventSummary ()
	Important for memory handling. More...

int	getI (ESI intval)
	return the specified int value - see EventSummaryIntValues for possible values, for example getI( ESI::chpfonum ) returns the number of charged PFOs in the event. More...

float	getF (ESF floatval)
	return the specified float value - see EventSummaryFloatValues for possible values, for example getF( ESF::thrust ) returns the thrust value of the event. More...

double	getD (ESD doubleval)
	return the specified double value - see EventSummaryDoubleValues for possible values, not used currently. More...

void	setI (ESI intval, int val)
	set the specified int value - see EventSummaryIntValues for possible values, for example set( ESI::chpfonum , 42 ) sets the number of charged PFOs in the event. More...

void	setF (ESF floatval, float val)
	set the specified float value - see EventSummaryFloatValues for possible values, for example set( ESF::thrust , .7 ) sets the thrust value the event. More...

void	setD (ESD doubleval, double val)
	set the specified double value - see EventSummaryDoubleValues for possible values, not used currently More...

void	print (std::ostream &os)

const std::string	getTypeName () const
	The type name of the user class (typically the class name) This type name is stored as a collection parameter "TypeName" with every collection of LCGenericObject subclasses. More...

const std::string	getDataDescription () const
	The description string. More...

Public Member Functions inherited from UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>
	LCFixedObject (const LCFixedObject &)=default
	default copy constructor - use with care More...

	LCFixedObject ()
	Default c'tor. More...

	LCFixedObject (LCObject *object)
	C'tor to be used for elements of LCGenericObjects read from an LCIO file or the database. More...

LCFixedObject &	operator= (const LCFixedObject &)=default
	default assignment operator - use with care More...

IMPL::LCGenericObjectImpl *	obj ()
	The LCGenericObjectImpl . More...

virtual	~LCFixedObject ()
	Clean up if we created a new LCGenericObjectImpl. More...

virtual int	id () const
	Return the id of the underlying LCGenericObjectImpl. More...

int	getNInt () const
	Number of integer values stored in this object. More...

int	getNFloat () const
	Number of float values stored in this object. More...

int	getNDouble () const
	Number of double values stored in this object. More...

int	getIntVal (int index) const
	Returns the integer value for the given index. More...

float	getFloatVal (int index) const
	Returns the float value for the given index. More...

double	getDoubleVal (int index) const
	Returns the double value for the given index. More...

bool	isFixedSize () const
	True if objects of the implementation class have a fixed size, i.e getNInt, getNFloat and getNDouble will return values that are constant during the lifetime of the object. More...

Public Member Functions inherited from EVENT::LCGenericObject
virtual	~LCGenericObject ()
	Destructor. More...

Public Member Functions inherited from EVENT::LCObject
virtual	~LCObject ()
	Destructor. More...

virtual LCObject *	clone () const
	Returns an object id for internal (debugging) use in LCIO. More...

Public Member Functions inherited from lcrtrel::LCRTRelations
template<class V >
V::ext_type	ext ()
	Provides access to an extension object - the type and ownership is defined by the class V which should be a subtype of LCExtension, LCOwnedExtension, LCExtensionVector, LCExtensionList,... More...

template<class V >
const V::ext_type	ext () const
	Provides access to an extension object - the type and ownership is defined by the class V which should be a subtype of LCExtension, LCOwnedExtension, LCExtensionVector, LCExtensionList,... More...

template<class V >
V::rel_type	rel ()
	Provides read access to relations - the object types and their connectivity are defined by the class V which has to be a subtype of either LC1To1Relation, LC1ToNRelation or LCNToNRelation. More...

Additional Inherited Members
Public Types inherited from EVENT::LCGenericObject
typedef LCGenericObject	lcobject_type
	Useful typedef for template programming with LCIO. More...

Public Types inherited from lcrtrel::LCRTRelations
typedef std::type_index	ext_index

typedef std::shared_ptr< void >	ext_type

typedef std::map< ext_index, ext_type >	ext_map

Protected Attributes inherited from UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>
IMPL::LCGenericObjectImpl *	_obj

bool	_createdObject

Detailed Description

Utility class for storing an event summary as an LCGenericObject.

Author: F.Gaede, DESY

Date: June 2020

Definition at line 70 of file EventSummary.h.

Constructor & Destructor Documentation

UTIL::EventSummary::EventSummary ( )

default

Convenient c'tor.

UTIL::EventSummary::EventSummary ( LCObject * o )

inline

'Copy constructor' needed to interpret LCCollection read from file/database.

Definition at line 80 of file EventSummary.h.

virtual UTIL::EventSummary::~EventSummary ( )

inlinevirtual

Important for memory handling.

Definition at line 83 of file EventSummary.h.

Member Function Documentation

double UTIL::EventSummary::getD ( ESD doubleval )

inline

return the specified double value - see EventSummaryDoubleValues for possible values, not used currently.

Definition at line 100 of file EventSummary.h.

References IMPL::LCGenericObjectImpl::getDoubleVal(), and UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>::obj().

const std::string UTIL::EventSummary::getDataDescription ( ) const

inlinevirtual

The description string.

A comma separated list of pairs of type identifier, one of 'i','f','d' followed by ':' and an attribute name, e.g. "i:cellId,f:offset,f:gain".

Implements EVENT::LCGenericObject.

Definition at line 128 of file EventSummary.h.

float UTIL::EventSummary::getF ( ESF floatval )

inline

return the specified float value - see EventSummaryFloatValues for possible values, for example getF( ESF::thrust ) returns the thrust value of the event.

Definition at line 95 of file EventSummary.h.

References IMPL::LCGenericObjectImpl::getFloatVal(), and UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>::obj().

int UTIL::EventSummary::getI ( ESI intval )

inline

return the specified int value - see EventSummaryIntValues for possible values, for example getI( ESI::chpfonum ) returns the number of charged PFOs in the event.

Definition at line 90 of file EventSummary.h.

References IMPL::LCGenericObjectImpl::getIntVal(), and UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>::obj().

const std::string UTIL::EventSummary::getTypeName ( ) const

inlinevirtual

The type name of the user class (typically the class name) This type name is stored as a collection parameter "TypeName" with every collection of LCGenericObject subclasses.

Implements EVENT::LCGenericObject.

Definition at line 124 of file EventSummary.h.

void UTIL::EventSummary::print ( std::ostream & os )

void UTIL::EventSummary::setD	(	ESD	doubleval,
		double	val
	)

inline

set the specified double value - see EventSummaryDoubleValues for possible values, not used currently

Definition at line 115 of file EventSummary.h.

References UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>::obj(), and IMPL::LCGenericObjectImpl::setDoubleVal().

void UTIL::EventSummary::setF	(	ESF	floatval,
		float	val
	)

inline

set the specified float value - see EventSummaryFloatValues for possible values, for example set( ESF::thrust , .7 ) sets the thrust value the event.

Definition at line 110 of file EventSummary.h.

References UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>::obj(), and IMPL::LCGenericObjectImpl::setFloatVal().

void UTIL::EventSummary::setI	(	ESI	intval,
		int	val
	)

inline

set the specified int value - see EventSummaryIntValues for possible values, for example set( ESI::chpfonum , 42 ) sets the number of charged PFOs in the event.

Definition at line 105 of file EventSummary.h.

References UTIL::LCFixedObject< int(ESI::SIZE), int(ESF::SIZE), int(ESD::SIZE)>::obj(), and IMPL::LCGenericObjectImpl::setIntVal().

The documentation for this class was generated from the following file:

/afs/desy.de/user/d/dudarboh/iLCSoft/LCIO/src/cpp/include/UTIL/EventSummary.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation