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::Geant4SharedStackingAction Class Reference

Implementation of the Geant4 shared stacking action. More...

#include <Geant4StackingAction.h>

Inheritance diagram for dd4hep::sim::Geant4SharedStackingAction:
dd4hep::sim::Geant4StackingAction dd4hep::sim::Geant4Action

Public Member Functions

 Geant4SharedStackingAction (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4SharedStackingAction ()
 Default destructor. More...
 
virtual void configureFiber (Geant4Context *thread_context) override
 Set or update client for the use in a new thread fiber. More...
 
virtual void use (Geant4StackingAction *action)
 Underlying object to be used during the execution of this thread. More...
 
virtual void newStage (G4StackManager *stackManager) override
 New-stage callback. More...
 
virtual void prepare (G4StackManager *stackManager) override
 Preparation callback. More...
 
virtual TrackClassification classifyNewTrack (G4StackManager *stackManager, const G4Track *track) override
 Return TrackClassification with enum G4ClassificationOfNewTrack or NoTrackClassification. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4StackingAction
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4StackingAction)
 Define standard assignments and constructors. More...
 
 Geant4StackingAction (Geant4Context *ctxt, const std::string &name)
 Standard constructor. More...
 
virtual ~Geant4StackingAction ()
 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

 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4SharedStackingAction)
 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

Geant4StackingActionm_action
 Reference to the shared action. 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::Geant4StackingAction
typedef Geant4SharedStackingAction shared_type
 

Detailed Description

Implementation of the Geant4 shared stacking action.

Wrapper to share single instances of stacking actions for multi-threaded purposes. The wrapper ensures the locking of the basic actions to avoid race conditions.

Shared action should be 'fast'. The global lock otherwise inhibits the efficient use of the multiple threads.

Author
M.Frank
Version
1.0

Definition at line 89 of file Geant4StackingAction.h.

Constructor & Destructor Documentation

◆ Geant4SharedStackingAction()

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

Standard constructor.

Definition at line 45 of file Geant4StackingAction.cpp.

◆ ~Geant4SharedStackingAction()

Geant4SharedStackingAction::~Geant4SharedStackingAction ( )
virtual

Default destructor.

Definition at line 52 of file Geant4StackingAction.cpp.

Member Function Documentation

◆ classifyNewTrack()

TrackClassification Geant4SharedStackingAction::classifyNewTrack ( G4StackManager *  stackManager,
const G4Track *  track 
)
overridevirtual

Return TrackClassification with enum G4ClassificationOfNewTrack or NoTrackClassification.

Classify new track with delegation.

Reimplemented from dd4hep::sim::Geant4StackingAction.

Definition at line 95 of file Geant4StackingAction.cpp.

◆ configureFiber()

void Geant4SharedStackingAction::configureFiber ( Geant4Context thread_context)
overridevirtual

Set or update client for the use in a new thread fiber.

Reimplemented from dd4hep::sim::Geant4Action.

Definition at line 58 of file Geant4StackingAction.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4SharedStackingAction::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4SharedStackingAction  )
protected

Define standard assignments and constructors.

◆ newStage()

void Geant4SharedStackingAction::newStage ( G4StackManager *  stackManager)
overridevirtual

New-stage callback.

Begin-of-stacking callback.

Reimplemented from dd4hep::sim::Geant4StackingAction.

Definition at line 74 of file Geant4StackingAction.cpp.

◆ prepare()

void Geant4SharedStackingAction::prepare ( G4StackManager *  stackManager)
overridevirtual

Preparation callback.

End-of-stacking callback.

Reimplemented from dd4hep::sim::Geant4StackingAction.

Definition at line 84 of file Geant4StackingAction.cpp.

◆ use()

void Geant4SharedStackingAction::use ( Geant4StackingAction action)
virtual

Underlying object to be used during the execution of this thread.

Definition at line 63 of file Geant4StackingAction.cpp.

Member Data Documentation

◆ m_action

Geant4StackingAction* dd4hep::sim::Geant4SharedStackingAction::m_action
protected

Reference to the shared action.

Definition at line 92 of file Geant4StackingAction.h.


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