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

Concrete implementation of the Geant4 stacking action base class. More...

#include <Geant4StackingAction.h>

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

Public Types

typedef Geant4SharedStackingAction shared_type
 

Public Member Functions

 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...
 
virtual void newStage (G4StackManager *)
 New-stage callback. More...
 
virtual void prepare (G4StackManager *)
 Preparation callback. More...
 
virtual TrackClassification classifyNewTrack (G4StackManager *, const G4Track *track)
 Return TrackClassification with enum G4ClassificationOfNewTrack or NoTrackClassification. 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...
 

Friends

class Geant4StackingActionSequence
 

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

Concrete implementation of the Geant4 stacking action base class.

Author
M.Frank
Version
1.0

Definition at line 52 of file Geant4StackingAction.h.

Member Typedef Documentation

◆ shared_type

Definition at line 55 of file Geant4StackingAction.h.

Constructor & Destructor Documentation

◆ Geant4StackingAction()

Geant4StackingAction::Geant4StackingAction ( Geant4Context ctxt,
const std::string &  name 
)

Standard constructor.

Definition at line 28 of file Geant4StackingAction.cpp.

◆ ~Geant4StackingAction()

Geant4StackingAction::~Geant4StackingAction ( )
virtual

Default destructor.

Definition at line 34 of file Geant4StackingAction.cpp.

Member Function Documentation

◆ classifyNewTrack()

TrackClassification Geant4StackingAction::classifyNewTrack ( G4StackManager *  ,
const G4Track *  track 
)
virtual

Return TrackClassification with enum G4ClassificationOfNewTrack or NoTrackClassification.

Classify new track: The first call in the sequence returning non-null pointer wins!

Reimplemented in dd4hep::sim::Geant4SharedStackingAction, and dd4hep::sim::Test::Geant4TestStackAction.

Definition at line 40 of file Geant4StackingAction.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4StackingAction::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4StackingAction  )

Define standard assignments and constructors.

◆ newStage()

virtual void dd4hep::sim::Geant4StackingAction::newStage ( G4StackManager *  )
inlinevirtual

New-stage callback.

Reimplemented in dd4hep::sim::Geant4SharedStackingAction, and dd4hep::sim::Test::Geant4TestStackAction.

Definition at line 66 of file Geant4StackingAction.h.

◆ prepare()

virtual void dd4hep::sim::Geant4StackingAction::prepare ( G4StackManager *  )
inlinevirtual

Preparation callback.

Reimplemented in dd4hep::sim::Geant4SharedStackingAction, and dd4hep::sim::Test::Geant4TestStackAction.

Definition at line 69 of file Geant4StackingAction.h.

Friends And Related Function Documentation

◆ Geant4StackingActionSequence

friend class Geant4StackingActionSequence
friend

Definition at line 54 of file Geant4StackingAction.h.


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