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

Class to populate Geant4 primaries from StdHep files. More...

Inheritance diagram for dd4hep::sim::Geant4EventReaderHepEvt:
dd4hep::sim::Geant4EventReader

Public Member Functions

 Geant4EventReaderHepEvt (const std::string &nam, int format)
 Initializing constructor. More...
 
virtual ~Geant4EventReaderHepEvt ()
 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...
 
virtual EventReaderStatus moveToEvent (int event_number)
 Move to the indicated event number. More...
 
virtual EventReaderStatus skipEvent ()
 Skip event. To be implemented for sequential sources. 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

std::ifstream m_input
 
int m_format
 
- 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

Class to populate Geant4 primaries from StdHep files.

Class to populate Geant4 primary particles and vertices from a file in HEPEvt format (ASCII)

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

Definition at line 47 of file Geant4EventReaderHepEvt.cpp.

Constructor & Destructor Documentation

◆ Geant4EventReaderHepEvt()

dd4hep::sim::Geant4EventReaderHepEvt::Geant4EventReaderHepEvt ( const std::string &  nam,
int  format 
)
explicit

Initializing constructor.

◆ ~Geant4EventReaderHepEvt()

virtual dd4hep::sim::Geant4EventReaderHepEvt::~Geant4EventReaderHepEvt ( )
virtual

Default destructor.

Member Function Documentation

◆ moveToEvent()

virtual EventReaderStatus dd4hep::sim::Geant4EventReaderHepEvt::moveToEvent ( int  event_number)
virtual

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.

◆ readParticles()

virtual EventReaderStatus dd4hep::sim::Geant4EventReaderHepEvt::readParticles ( int  event_number,
Vertices vertices,
std::vector< Particle * > &  particles 
)
virtual

Read an event and fill a vector of MCParticles.

◆ skipEvent()

virtual EventReaderStatus dd4hep::sim::Geant4EventReaderHepEvt::skipEvent ( )
inlinevirtual

Skip event. To be implemented for sequential sources.

Reimplemented from dd4hep::sim::Geant4EventReader.

Definition at line 63 of file Geant4EventReaderHepEvt.cpp.

Member Data Documentation

◆ m_format

int dd4hep::sim::Geant4EventReaderHepEvt::m_format
protected

Definition at line 51 of file Geant4EventReaderHepEvt.cpp.

◆ m_input

std::ifstream dd4hep::sim::Geant4EventReaderHepEvt::m_input
protected

Definition at line 50 of file Geant4EventReaderHepEvt.cpp.


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