DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Attributes | List of all members
dd4hep::sim::LCIOStdHepReader Class Reference

Base class to read StdHep files with lcio. More...

Inheritance diagram for dd4hep::sim::LCIOStdHepReader:
dd4hep::sim::LCIOEventReader dd4hep::sim::Geant4EventReader

Public Member Functions

 LCIOStdHepReader (const std::string &nam)
 Initializing constructor. More...
 
virtual ~LCIOStdHepReader ()
 Default destructor. More...
 
virtual EventReaderStatus readParticleCollection (int event_number, EVENT::LCCollection **particles) override
 Read an event and fill a vector of MCParticles. More...
 
virtual EventReaderStatus moveToEvent (int event_number) override
 Move to the indicated event number. More...
 
virtual EventReaderStatus skipEvent () override
 Skip event. To be implemented for sequential sources. More...
 
- 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...
 
Geant4Contextcontext () 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 EventReaderStatus setParameters (std::map< std::string, std::string > &)
 pass parameters to the event reader object 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

UTIL::LCStdHepRdr * m_reader
 Reference to Reader object. More...
 
- 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...
 
Geant4InputActionm_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 StdHep files with lcio.

Author
P.Kostka (main author)
M.Frank (code reshuffeling into new DDG4 scheme)
Version
1.0

Definition at line 46 of file LCIOStdHepReader.cpp.

Constructor & Destructor Documentation

◆ LCIOStdHepReader()

dd4hep::sim::LCIOStdHepReader::LCIOStdHepReader ( const std::string &  nam)

Initializing constructor.

◆ ~LCIOStdHepReader()

virtual dd4hep::sim::LCIOStdHepReader::~LCIOStdHepReader ( )
virtual

Default destructor.

Member Function Documentation

◆ moveToEvent()

virtual EventReaderStatus dd4hep::sim::LCIOStdHepReader::moveToEvent ( int  event_number)
overridevirtual

Move to the indicated event number.

For pure sequential access, the default implementation will skip events one by one. For technologies supporting direct event access the default implementation will be empty.

Returns

Reimplemented from dd4hep::sim::Geant4EventReader.

◆ readParticleCollection()

virtual EventReaderStatus dd4hep::sim::LCIOStdHepReader::readParticleCollection ( int  event_number,
EVENT::LCCollection **  particles 
)
overridevirtual

Read an event and fill a vector of MCParticles.

Implements dd4hep::sim::LCIOEventReader.

◆ skipEvent()

virtual EventReaderStatus dd4hep::sim::LCIOStdHepReader::skipEvent ( )
inlineoverridevirtual

Skip event. To be implemented for sequential sources.

Reimplemented from dd4hep::sim::Geant4EventReader.

Definition at line 59 of file LCIOStdHepReader.cpp.

Member Data Documentation

◆ m_reader

UTIL::LCStdHepRdr* dd4hep::sim::LCIOStdHepReader::m_reader
protected

Reference to Reader object.

Definition at line 49 of file LCIOStdHepReader.cpp.


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