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

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

#include <Geant4GeneratorAction.h>

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

Public Member Functions

 Geant4SharedGeneratorAction (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4SharedGeneratorAction ()
 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 (Geant4GeneratorAction *action)
 Underlying object to be used during the execution of this thread. More...
 
virtual void operator() (G4Event *event) override
 User generator 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...
 
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 (Geant4SharedGeneratorAction)
 Define standard assignments and constructors. More...
 
- 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...
 

Protected Attributes

Geant4GeneratorActionm_action = 0
 Reference to the shared action. 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
 

Detailed Description

Implementation of the Geant4 shared generator action.

Wrapper to share single instances of generator 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 78 of file Geant4GeneratorAction.h.

Constructor & Destructor Documentation

◆ Geant4SharedGeneratorAction()

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

Standard constructor.

Definition at line 41 of file Geant4GeneratorAction.cpp.

◆ ~Geant4SharedGeneratorAction()

Geant4SharedGeneratorAction::~Geant4SharedGeneratorAction ( )
virtual

Default destructor.

Definition at line 48 of file Geant4GeneratorAction.cpp.

Member Function Documentation

◆ configureFiber()

void Geant4SharedGeneratorAction::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 54 of file Geant4GeneratorAction.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4SharedGeneratorAction::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4SharedGeneratorAction  )
protected

Define standard assignments and constructors.

◆ operator()()

void Geant4SharedGeneratorAction::operator() ( G4Event *  event)
overridevirtual

User generator callback.

Reimplemented from dd4hep::sim::Geant4GeneratorAction.

Definition at line 69 of file Geant4GeneratorAction.cpp.

◆ use()

void Geant4SharedGeneratorAction::use ( Geant4GeneratorAction action)
virtual

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

Definition at line 59 of file Geant4GeneratorAction.cpp.

Member Data Documentation

◆ m_action

Geant4GeneratorAction* dd4hep::sim::Geant4SharedGeneratorAction::m_action = 0
protected

Reference to the shared action.

Definition at line 81 of file Geant4GeneratorAction.h.


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