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

#include <HepMC3EventReader.h>

Inheritance diagram for dd4hep::sim::HEPMC3EventReader:
dd4hep::sim::Geant4EventReader dd4hep::sim::HEPMC3FileReader

Public Member Functions

 HEPMC3EventReader (const std::string &fileName)
 Initializing constructor. More...
 
virtual ~HEPMC3EventReader ()=default
 Default destructor. More...
 
virtual EventReaderStatus readParticles (int event_number, Vertices &vertices, Particles &particles)
 Read an event and fill a vector of Particles and vertices. More...
 
virtual EventReaderStatus readGenEvent (int event_number, HepMC3::GenEvent &genEvent)=0
 Read an event. 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 moveToEvent (int event_number)
 Move to the indicated event number. More...
 
virtual EventReaderStatus skipEvent ()
 Skip event. To be implemented for sequential sources. 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::string m_flow1 = "flow1"
 name of the GenEvent Attribute storing the color flow1 More...
 
std::string m_flow2 = "flow2"
 name of the GenEvent Attribute storing the color flow2 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

Definition at line 33 of file HepMC3EventReader.h.

Constructor & Destructor Documentation

◆ HEPMC3EventReader()

HEPMC3EventReader::HEPMC3EventReader ( const std::string &  fileName)
explicit

Initializing constructor.

Definition at line 50 of file HepMC3EventReader.cpp.

◆ ~HEPMC3EventReader()

virtual dd4hep::sim::HEPMC3EventReader::~HEPMC3EventReader ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ readGenEvent()

virtual EventReaderStatus dd4hep::sim::HEPMC3EventReader::readGenEvent ( int  event_number,
HepMC3::GenEvent &  genEvent 
)
pure virtual

Read an event.

Implemented in dd4hep::sim::HEPMC3FileReader.

◆ readParticles()

HEPMC3EventReader::EventReaderStatus HEPMC3EventReader::readParticles ( int  event_number,
Vertices vertices,
Particles particles 
)
virtual

Read an event and fill a vector of Particles and vertices.

Read an event and fill a vector of MCParticles.

Implements dd4hep::sim::Geant4EventReader.

Definition at line 54 of file HepMC3EventReader.cpp.

Member Data Documentation

◆ m_flow1

std::string dd4hep::sim::HEPMC3EventReader::m_flow1 = "flow1"
protected

name of the GenEvent Attribute storing the color flow1

Definition at line 47 of file HepMC3EventReader.h.

◆ m_flow2

std::string dd4hep::sim::HEPMC3EventReader::m_flow2 = "flow2"
protected

name of the GenEvent Attribute storing the color flow2

Definition at line 49 of file HepMC3EventReader.h.


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