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

Base class to output Geant4 event data to media. More...

Inheritance diagram for dd4hep::sim::Geant4Output2LCIO:
dd4hep::sim::Geant4OutputAction dd4hep::sim::Geant4EventAction dd4hep::sim::Geant4Action

Public Member Functions

 Geant4Output2LCIO (Geant4Context *ctxt, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4Output2LCIO ()
 Default destructor. More...
 
virtual void beginRun (const G4Run *run)
 Callback to store the Geant4 run information. More...
 
virtual void endRun (const G4Run *run)
 Callback to store the Geant4 run information. More...
 
virtual void saveRun (const G4Run *run)
 Callback to store the Geant4 run information. More...
 
virtual void saveEvent (OutputContext< G4Event > &ctxt)
 Callback to store the Geant4 event. More...
 
virtual void saveCollection (OutputContext< G4Event > &ctxt, G4VHitsCollection *collection)
 Callback to store each Geant4 hit collection. More...
 
virtual void commit (OutputContext< G4Event > &ctxt)
 Commit data at end of filling procedure. More...
 
virtual void begin (const G4Event *event)
 begin-of-event callback - creates LCIO event and adds it to the event context More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4OutputAction
 Geant4OutputAction ()=delete
 Inhibit default constructor. More...
 
 Geant4OutputAction (const Geant4OutputAction &copy)=delete
 Inhibit copy constructor. More...
 
 Geant4OutputAction (Geant4Context *c, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4OutputAction ()
 Default destructor. More...
 
virtual void configureFiber (Geant4Context *ctxt) override
 Set or update client for the use in a new thread fiber. More...
 
virtual void end (const G4Event *event) override
 End-of-event callback. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4EventAction
 Geant4EventAction (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4EventAction ()
 Default destructor. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4Action
 Geant4Action (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
long addRef ()
 Increase reference count. More...
 
long release ()
 Decrease reference count. Implicit destruction. More...
 
Geant4Contextcontext () const
 Access the context. More...
 
virtual void updateContext (Geant4Context *ctxt)
 Set or update client context. More...
 
const std::string & name () const
 Access name of the action. More...
 
const char * c_name () const
 Access name of the action. More...
 
void setName (const std::string &new_name)
 Set the object name. More...
 
PropertyManagerproperties ()
 Access to the properties of the object. More...
 
PrintLevel outputLevel () const
 Access the output level. More...
 
PrintLevel setOutputLevel (PrintLevel new_level)
 Set the output level; returns previous value. More...
 
Geant4UIMessengercontrol () const
 Access to the UI messenger. More...
 
virtual void enableUI ()
 Enable and install UI messenger. More...
 
template<typename T >
Geant4ActiondeclareProperty (const std::string &nam, T &val)
 Declare property. More...
 
template<typename T >
Geant4ActiondeclareProperty (const char *nam, T &val)
 Declare property. More...
 
bool hasProperty (const std::string &name) const
 Check property for existence. More...
 
Propertyproperty (const std::string &name)
 Access single property. More...
 
virtual void installMessengers ()
 Install property control messenger if wanted. More...
 
virtual void installCommandMessenger ()
 Install command control messenger if wanted. More...
 
virtual void installPropertyMessenger ()
 Install property control messenger if wanted. More...
 
void print (const char *fmt,...) const
 Support for messages with variable output level using output level. More...
 
void printM1 (const char *fmt,...) const
 Support for messages with variable output level using output level-1. More...
 
void printM2 (const char *fmt,...) const
 Support for messages with variable output level using output level-2. More...
 
void printP1 (const char *fmt,...) const
 Support for messages with variable output level using output level+1. More...
 
void printP2 (const char *fmt,...) const
 Support for messages with variable output level using output level+2. More...
 
void always (const char *fmt,...) const
 Support of always printed messages. More...
 
void debug (const char *fmt,...) const
 Support of debug messages. More...
 
void info (const char *fmt,...) const
 Support of info messages. More...
 
void warning (const char *fmt,...) const
 Support of warning messages. More...
 
void error (const char *fmt,...) const
 Support of error messages. More...
 
bool return_error (bool return_value, const char *fmt,...) const
 Action to support error messages. More...
 
void fatal (const char *fmt,...) const
 Support of fatal messages. Throws exception. More...
 
void except (const char *fmt,...) const
 Support of exceptions: Print fatal message and throw runtime_error. More...
 
void abortRun (const std::string &exception, const char *fmt,...) const
 Abort Geant4 Run by throwing a G4Exception with type RunMustBeAborted. More...
 
Geant4RunActionSequencerunAction () const
 Access to the main run action sequence from the kernel object. More...
 
Geant4EventActionSequenceeventAction () const
 Access to the main event action sequence from the kernel object. More...
 
Geant4SteppingActionSequencesteppingAction () const
 Access to the main stepping action sequence from the kernel object. More...
 
Geant4TrackingActionSequencetrackingAction () const
 Access to the main tracking action sequence from the kernel object. More...
 
Geant4StackingActionSequencestackingAction () const
 Access to the main stacking action sequence from the kernel object. More...
 
Geant4GeneratorActionSequencegeneratorAction () const
 Access to the main generator action sequence from the kernel object. More...
 

Protected Member Functions

lcio::LCCollectionVec * saveParticles (Geant4ParticleMap *particles)
 Data conversion interface for MC particles to LCIO format. More...
 
template<typename T >
void saveEventParameters (lcio::LCEventImpl *event, const std::map< std::string, std::string > &parameters)
 Fill event parameters in LCIO event. More...
 
- Protected Member Functions inherited from dd4hep::sim::Geant4EventAction
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4EventAction)
 Define standard assignments and constructors. More...
 
- Protected Member Functions inherited from dd4hep::sim::Geant4Action
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Action)
 Define standard assignments and constructors. More...
 
virtual ~Geant4Action ()
 Default destructor. More...
 

Protected Attributes

lcio::LCWriter * m_file
 
int m_runNo
 
int m_runNumberOffset
 
int m_eventNumberOffset
 
std::map< std::string, std::string > m_runHeader
 
std::map< std::string, std::string > m_eventParametersInt
 
std::map< std::string, std::string > m_eventParametersFloat
 
std::map< std::string, std::string > m_eventParametersString
 
- Protected Attributes inherited from dd4hep::sim::Geant4OutputAction
std::string m_output { }
 Property: "Output" output destination. More...
 
bool m_errorFatal { true }
 Property: "HandleErrorsAsFatal" Handle errors as fatal and rethrow eventual exceptions. More...
 
Geant4ParticleMapm_truth { nullptr }
 Reference to MC truth object. More...
 
- Protected Attributes inherited from dd4hep::sim::Geant4Action
Geant4Contextm_context { nullptr }
 Reference to the Geant4 context. More...
 
Geant4UIMessengerm_control { nullptr }
 Control directory of this action. More...
 
int m_outputLevel { 3 }
 Default property: Output level. More...
 
bool m_needsControl { false }
 Default property: Flag to create control instance. More...
 
std::string m_name { }
 Action name. More...
 
PropertyManager m_properties { }
 Property pool. More...
 
long m_refCount { 1 }
 Reference count. Initial value: 1. More...
 

Additional Inherited Members

- Public Types inherited from dd4hep::sim::Geant4EventAction
typedef Geant4SharedEventAction shared_type
 

Detailed Description

Base class to output Geant4 event data to media.

Author
M.Frank
R.Ete (added event parameters treatment)
Version
1.0

Definition at line 93 of file Geant4Output2LCIO.cpp.

Constructor & Destructor Documentation

◆ Geant4Output2LCIO()

Geant4Output2LCIO::Geant4Output2LCIO ( Geant4Context ctxt,
const std::string &  nam 
)

Standard constructor.

Definition at line 209 of file Geant4Output2LCIO.cpp.

◆ ~Geant4Output2LCIO()

Geant4Output2LCIO::~Geant4Output2LCIO ( )
virtual

Default destructor.

Definition at line 222 of file Geant4Output2LCIO.cpp.

Member Function Documentation

◆ begin()

void Geant4Output2LCIO::begin ( const G4Event *  event)
virtual

begin-of-event callback - creates LCIO event and adds it to the event context

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 278 of file Geant4Output2LCIO.cpp.

◆ beginRun()

void Geant4Output2LCIO::beginRun ( const G4Run *  run)
virtual

Callback to store the Geant4 run information.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 232 of file Geant4Output2LCIO.cpp.

◆ commit()

void Geant4Output2LCIO::commit ( OutputContext< G4Event > &  ctxt)
virtual

Commit data at end of filling procedure.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 248 of file Geant4Output2LCIO.cpp.

◆ endRun()

void Geant4Output2LCIO::endRun ( const G4Run *  run)
virtual

Callback to store the Geant4 run information.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 243 of file Geant4Output2LCIO.cpp.

◆ saveCollection()

void Geant4Output2LCIO::saveCollection ( OutputContext< G4Event > &  ctxt,
G4VHitsCollection collection 
)
virtual

Callback to store each Geant4 hit collection.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 436 of file Geant4Output2LCIO.cpp.

◆ saveEvent()

void Geant4Output2LCIO::saveEvent ( OutputContext< G4Event > &  ctxt)
virtual

Callback to store the Geant4 event.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 397 of file Geant4Output2LCIO.cpp.

◆ saveEventParameters()

template<typename T >
void dd4hep::sim::Geant4Output2LCIO::saveEventParameters ( lcio::LCEventImpl *  event,
const std::map< std::string, std::string > &  parameters 
)
inlineprotected

Fill event parameters in LCIO event.

Definition at line 135 of file Geant4Output2LCIO.cpp.

◆ saveParticles()

lcio::LCCollectionVec * Geant4Output2LCIO::saveParticles ( Geant4ParticleMap particles)
protected

Data conversion interface for MC particles to LCIO format.

Definition at line 286 of file Geant4Output2LCIO.cpp.

◆ saveRun()

void Geant4Output2LCIO::saveRun ( const G4Run *  run)
virtual

Callback to store the Geant4 run information.

Reimplemented from dd4hep::sim::Geant4OutputAction.

Definition at line 259 of file Geant4Output2LCIO.cpp.

Member Data Documentation

◆ m_eventNumberOffset

int dd4hep::sim::Geant4Output2LCIO::m_eventNumberOffset
protected

Definition at line 98 of file Geant4Output2LCIO.cpp.

◆ m_eventParametersFloat

std::map< std::string, std::string > dd4hep::sim::Geant4Output2LCIO::m_eventParametersFloat
protected

Definition at line 101 of file Geant4Output2LCIO.cpp.

◆ m_eventParametersInt

std::map< std::string, std::string > dd4hep::sim::Geant4Output2LCIO::m_eventParametersInt
protected

Definition at line 100 of file Geant4Output2LCIO.cpp.

◆ m_eventParametersString

std::map< std::string, std::string > dd4hep::sim::Geant4Output2LCIO::m_eventParametersString
protected

Definition at line 102 of file Geant4Output2LCIO.cpp.

◆ m_file

lcio::LCWriter* dd4hep::sim::Geant4Output2LCIO::m_file
protected

Definition at line 95 of file Geant4Output2LCIO.cpp.

◆ m_runHeader

std::map< std::string, std::string > dd4hep::sim::Geant4Output2LCIO::m_runHeader
protected

Definition at line 99 of file Geant4Output2LCIO.cpp.

◆ m_runNo

int dd4hep::sim::Geant4Output2LCIO::m_runNo
protected

Definition at line 96 of file Geant4Output2LCIO.cpp.

◆ m_runNumberOffset

int dd4hep::sim::Geant4Output2LCIO::m_runNumberOffset
protected

Definition at line 97 of file Geant4Output2LCIO.cpp.


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