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

Default base class for all geant 4 tracking actions used in DDG4. More...

#include <Geant4TrackingAction.h>

Inheritance diagram for dd4hep::sim::Geant4TrackingAction:
dd4hep::sim::Geant4Action dd4hep::sim::Geant4SharedTrackingAction dd4hep::sim::Geant4TrackingPostAction dd4hep::sim::Geant4TrackingPreAction dd4hep::sim::Test::Geant4TestTrackAction

Public Types

typedef Geant4SharedTrackingAction shared_type
 

Public Member Functions

 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4TrackingAction)
 Define standard assignments and constructors. More...
 
 Geant4TrackingAction (Geant4Context *context, const std::string &name="")
 Standard constructor. More...
 
virtual ~Geant4TrackingAction ()
 Default destructor. More...
 
G4TrackingManager * trackMgr () const
 Access the Geant4 tracking manager. Only use between tracking pre- and post action. More...
 
void mark (const G4Track *track) const
 Mark the track to be kept for MC truth propagation. More...
 
virtual void begin (const G4Track *track)
 Pre-track action callback. More...
 
virtual void end (const G4Track *track)
 Post-track action callback. 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...
 

Additional Inherited Members

- 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 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...
 

Detailed Description

Default base class for all geant 4 tracking actions used in DDG4.

Author
M.Frank
Version
1.0

Definition at line 41 of file Geant4TrackingAction.h.

Member Typedef Documentation

◆ shared_type

Definition at line 43 of file Geant4TrackingAction.h.

Constructor & Destructor Documentation

◆ Geant4TrackingAction()

Geant4TrackingAction::Geant4TrackingAction ( Geant4Context context,
const std::string &  name = "" 
)

Standard constructor.

Definition at line 95 of file Geant4TrackingAction.cpp.

◆ ~Geant4TrackingAction()

Geant4TrackingAction::~Geant4TrackingAction ( )
virtual

Default destructor.

Definition at line 101 of file Geant4TrackingAction.cpp.

Member Function Documentation

◆ begin()

void Geant4TrackingAction::begin ( const G4Track *  track)
virtual

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4TrackingAction::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4TrackingAction  )

Define standard assignments and constructors.

◆ end()

void Geant4TrackingAction::end ( const G4Track *  track)
virtual

◆ mark()

void Geant4TrackingAction::mark ( const G4Track *  track) const

Mark the track to be kept for MC truth propagation.

Definition at line 114 of file Geant4TrackingAction.cpp.

◆ trackMgr()

G4TrackingManager* dd4hep::sim::Geant4TrackingAction::trackMgr ( ) const
inline

Access the Geant4 tracking manager. Only use between tracking pre- and post action.

Definition at line 53 of file Geant4TrackingAction.h.


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