dd4hep::sim::LCIOFileReader Class Reference

Base class to read lcio event files. More...

Inheritance diagram for dd4hep::sim::LCIOFileReader:

Public Member Functions
	LCIOFileReader (const std::string &nam)
	Initializing constructor. More...
virtual	~LCIOFileReader ()
	Default destructor. More...
virtual EventReaderStatus	readParticleCollection (int event_number, EVENT::LCCollection **particles)
	Read an event and fill a vector of MCParticles. More...
virtual EventReaderStatus	moveToEvent (int event_number)
	moveToSpecifiedEvent, a.k.a. skipNEvents More...
virtual EventReaderStatus	skipEvent ()
	Skip event. To be implemented for sequential sources. More...
virtual EventReaderStatus	setParameters (std::map< std::string, std::string > &parameters)
Public Member Functions inherited from dd4hep::sim::LCIOEventReader
	LCIOEventReader (const std::string &nam)
	Initializing constructor. More...
virtual	~LCIOEventReader ()
	Default destructor. More...
virtual EventReaderStatus	readParticles (int event_number, Vertices &vertices, std::vector< Particle * > &particles)
	Read an event and fill a vector of MCParticles. More...
Public Member Functions inherited from dd4hep::sim::Geant4EventReader
	Geant4EventReader (const std::string &nam)
	Initializing constructor. More...
virtual	~Geant4EventReader ()
	Default destructor. More...
Geant4Context *	context () const
	Get the context (from the input action) More...
void	setInputAction (Geant4InputAction *action)
	Set the input action. More...
const std::string &	name () const
	File name. More...
bool	hasDirectAccess () const
	Flag if direct event access (by event sequence number) is supported (Default: false) More...
int	currentEventNumber () const
	return current Event Number More...
virtual EventReaderStatus	readParticles (int event_number, Vertices &vertices, Particles &particles)=0
	Read an event and fill a vector of MCParticles. More...
virtual void	checkParameters (std::map< std::string, std::string > &)
	make sure that all parameters have been processed, otherwise throw exceptions More...
virtual void	registerRunParameters ()
	Register Run Parameters. More...

Protected Attributes
IO::LCReader *	m_reader
	Reference to reader object. More...
std::string	m_collectionName
Protected Attributes inherited from dd4hep::sim::Geant4EventReader
std::string	m_name
	File name to be opened and read. More...
bool	m_directAccess { false }
	Flag if direct event access is supported. To be explicitly set by subclass constructors. More...
int	m_currEvent { 0 }
	Current event number. More...
Geant4InputAction *	m_inputAction { nullptr }
	The input action context. More...

Additional Inherited Members
Public Types inherited from dd4hep::sim::Geant4EventReader
enum	EventReaderStatus {   EVENT_READER_ERROR =0, EVENT_READER_OK =1, EVENT_READER_NO_DIRECT =2, EVENT_READER_NO_PRIMARIES =4,   EVENT_READER_NO_FACTORY =6, EVENT_READER_IO_ERROR =8, EVENT_READER_EOF =10 }
	Status codes of the event reader object. Anything with NOT low-bit set is an error. More...
typedef Geant4Vertex	Vertex
typedef Geant4Particle	Particle
typedef std::vector< Particle * >	Particles
typedef std::vector< Vertex * >	Vertices
Protected Member Functions inherited from dd4hep::sim::Geant4EventReader
template<typename T >
void	_getParameterValue (std::map< std::string, std::string > &parameters, std::string const &parameterName, T &parameter, T defaultValue)
	transform the string parameter value into the type of parameter More...

Detailed Description

Base class to read lcio event files.

Author

P.Kostka (main author)

M.Frank (code reshuffeling into new DDG4 scheme)

R.Ete (added event parameters in event context)

Version

1.0

Definition at line 78 of file LCIOFileReader.cpp.

Constructor & Destructor Documentation

LCIOFileReader()

dd4hep::sim::LCIOFileReader::LCIOFileReader

(

const std::string &

nam

)

Initializing constructor.

Definition at line 109 of file LCIOFileReader.cpp.

~LCIOFileReader()

dd4hep::sim::LCIOFileReader::~LCIOFileReader ( )

virtual

Default destructor.

Definition at line 120 of file LCIOFileReader.cpp.

Member Function Documentation

moveToEvent()

Geant4EventReader::EventReaderStatus dd4hep::sim::LCIOFileReader::moveToEvent ( int  event_number )

virtual

moveToSpecifiedEvent, a.k.a. skipNEvents

Reimplemented from dd4hep::sim::Geant4EventReader.

Definition at line 127 of file LCIOFileReader.cpp.

readParticleCollection()

Geant4EventReader::EventReaderStatus dd4hep::sim::LCIOFileReader::readParticleCollection ( int  event_number, EVENT::LCCollection **  particles  )

virtual

Read an event and fill a vector of MCParticles.

Implements dd4hep::sim::LCIOEventReader.

Definition at line 142 of file LCIOFileReader.cpp.

setParameters()

Geant4EventReader::EventReaderStatus dd4hep::sim::LCIOFileReader::setParameters ( std::map< std::string, std::string > &  parameters )

virtual

Set the parameters for the class, in particular the name of the MCParticle list

Reimplemented from dd4hep::sim::Geant4EventReader.

Definition at line 174 of file LCIOFileReader.cpp.

skipEvent()

virtual EventReaderStatus dd4hep::sim::LCIOFileReader::skipEvent ( )

inlinevirtual

Skip event. To be implemented for sequential sources.

Reimplemented from dd4hep::sim::Geant4EventReader.

Definition at line 92 of file LCIOFileReader.cpp.

Member Data Documentation

m_collectionName

std::string dd4hep::sim::LCIOFileReader::m_collectionName

protected

Definition at line 82 of file LCIOFileReader.cpp.

m_reader

IO::LCReader* dd4hep::sim::LCIOFileReader::m_reader

protected

Reference to reader object.

Definition at line 81 of file LCIOFileReader.cpp.

---

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

• DDG4/lcio/LCIOFileReader.cpp