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

Initialize the Geant4Event objects to host generator and MC truth related information. More...

#include <Geant4GeneratorActionInit.h>

Inheritance diagram for dd4hep::sim::Geant4GeneratorActionInit:
dd4hep::sim::Geant4GeneratorAction dd4hep::sim::Geant4Action

Public Member Functions

 Geant4GeneratorActionInit (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4GeneratorActionInit ()
 Default destructor. More...
 
virtual void operator() (G4Event *event)
 Event generation action callback. More...
 
void begin (const G4Run *run)
 Begin-run action callback. More...
 
void end (const G4Run *run)
 End-run action callback. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4GeneratorAction
 Geant4GeneratorAction (Geant4Context *context, const std::string &name)
 Standard constructor. More...
 
virtual ~Geant4GeneratorAction ()
 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...
 
virtual void configureFiber (Geant4Context *thread_context)
 Set or update client for the use in a new thread fiber. 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 Attributes

int m_run { 0 }
 Current run identifier. More...
 
int m_evtTotal { 0 }
 Counter for total number of events. More...
 
int m_evtRun { 0 }
 Counter for total number of events in current run. More...
 
- Protected Attributes inherited from dd4hep::sim::Geant4GeneratorAction
Callback m_calls
 
- 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::Geant4GeneratorAction
typedef Geant4SharedGeneratorAction shared_type
 
- Protected Member Functions inherited from dd4hep::sim::Geant4GeneratorAction
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4GeneratorAction)
 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...
 

Detailed Description

Initialize the Geant4Event objects to host generator and MC truth related information.

Geant4 actions to collect the MC particle information.

This action should register all event extension required for the further processing. We want to avoid that every client has to check if a given object is present or not and than later install the required data structures.

These by default are extensions of type: – Geant4PrimaryEvent with multiple interaction sections, one for each interaction This is the MAIN and ONLY information to feed Geant4

Geant4PrimaryInteraction containing the track/vertex information to create the primary particles for Geant4. This record is build from the Geant4PrimaryEvent information. – Geant4PrimaryMap a map of the Geant4Particles converted to G4PrimaryParticles to ease particle handling later. – Geant4ParticleMap the map of particles created during the event simulation. This map has directly the correct particle offsets, so that the merging of Geant4PrimaryInteraction particles and the simulation particles is easy....

Author
M.Frank
Version
1.0

Definition at line 54 of file Geant4GeneratorActionInit.h.

Constructor & Destructor Documentation

◆ Geant4GeneratorActionInit()

Geant4GeneratorActionInit::Geant4GeneratorActionInit ( Geant4Context context,
const std::string &  nam 
)

Standard constructor.

Definition at line 27 of file Geant4GeneratorActionInit.cpp.

◆ ~Geant4GeneratorActionInit()

Geant4GeneratorActionInit::~Geant4GeneratorActionInit ( )
virtual

Default destructor.

Definition at line 38 of file Geant4GeneratorActionInit.cpp.

Member Function Documentation

◆ begin()

void Geant4GeneratorActionInit::begin ( const G4Run *  run)

Begin-run action callback.

Definition at line 43 of file Geant4GeneratorActionInit.cpp.

◆ end()

void Geant4GeneratorActionInit::end ( const G4Run *  run)

End-run action callback.

Definition at line 49 of file Geant4GeneratorActionInit.cpp.

◆ operator()()

void Geant4GeneratorActionInit::operator() ( G4Event *  event)
virtual

Event generation action callback.

Update event counters

  • Printout

Reimplemented from dd4hep::sim::Geant4GeneratorAction.

Definition at line 56 of file Geant4GeneratorActionInit.cpp.

Member Data Documentation

◆ m_evtRun

int dd4hep::sim::Geant4GeneratorActionInit::m_evtRun { 0 }
protected

Counter for total number of events in current run.

Definition at line 61 of file Geant4GeneratorActionInit.h.

◆ m_evtTotal

int dd4hep::sim::Geant4GeneratorActionInit::m_evtTotal { 0 }
protected

Counter for total number of events.

Definition at line 59 of file Geant4GeneratorActionInit.h.

◆ m_run

int dd4hep::sim::Geant4GeneratorActionInit::m_run { 0 }
protected

Current run identifier.

Definition at line 57 of file Geant4GeneratorActionInit.h.


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