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

Interface class to access properties of the underlying Geant4 sensitive detector structure. More...

#include <Geant4SensDetAction.h>

Inheritance diagram for dd4hep::sim::Geant4ActionSD:
dd4hep::sim::Geant4Action dd4hep::sim::Geant4SensDet

Public Member Functions

virtual std::size_t defineCollection (const std::string &name)=0
 Initialize the usage of a hit collection. Returns the collection identifier. More...
 
virtual G4VReadOutGeometry * readoutGeometry () const =0
 Access to the readout geometry of the sensitive detector. More...
 
virtual G4int GetCollectionID (G4int i)=0
 This is a utility method which returns the hits collection ID. More...
 
virtual bool isActive () const =0
 Is the detector active? More...
 
virtual SensitiveDetector sensitiveDetector () const =0
 Access to the Detector sensitive detector handle. More...
 
virtual std::string path () const =0
 G4VSensitiveDetector internals: Access to the detector path name. More...
 
virtual std::string fullPath () const =0
 G4VSensitiveDetector internals: Access to the detector path name. More...
 
virtual const std::string & sensitiveType () const =0
 Access to the sensitive type of the detector. 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 Member Functions

 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4ActionSD)
 Define standard assignments and constructors. More...
 
 Geant4ActionSD (const std::string &name)
 Standard action constructor. More...
 
virtual ~Geant4ActionSD ()
 Default destructor. 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...
 

Additional Inherited Members

- 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

Interface class to access properties of the underlying Geant4 sensitive detector structure.

Author
M.Frank
Version
1.0

Definition at line 61 of file Geant4SensDetAction.h.

Constructor & Destructor Documentation

◆ Geant4ActionSD()

Geant4ActionSD::Geant4ActionSD ( const std::string &  name)
protected

Standard action constructor.

Definition at line 65 of file Geant4SensDetAction.cpp.

◆ ~Geant4ActionSD()

Geant4ActionSD::~Geant4ActionSD ( )
protectedvirtual

Default destructor.

Definition at line 71 of file Geant4SensDetAction.cpp.

Member Function Documentation

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4ActionSD::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4ActionSD  )
protected

Define standard assignments and constructors.

◆ defineCollection()

virtual std::size_t dd4hep::sim::Geant4ActionSD::defineCollection ( const std::string &  name)
pure virtual

Initialize the usage of a hit collection. Returns the collection identifier.

Implemented in dd4hep::sim::Geant4SensDet.

◆ fullPath()

virtual std::string dd4hep::sim::Geant4ActionSD::fullPath ( ) const
pure virtual

G4VSensitiveDetector internals: Access to the detector path name.

Implemented in dd4hep::sim::Geant4SensDet.

◆ GetCollectionID()

virtual G4int dd4hep::sim::Geant4ActionSD::GetCollectionID ( G4int  i)
pure virtual

This is a utility method which returns the hits collection ID.

Implemented in dd4hep::sim::Geant4SensDet.

◆ isActive()

virtual bool dd4hep::sim::Geant4ActionSD::isActive ( ) const
pure virtual

Is the detector active?

Implemented in dd4hep::sim::Geant4SensDet.

◆ path()

virtual std::string dd4hep::sim::Geant4ActionSD::path ( ) const
pure virtual

G4VSensitiveDetector internals: Access to the detector path name.

Implemented in dd4hep::sim::Geant4SensDet.

◆ readoutGeometry()

virtual G4VReadOutGeometry* dd4hep::sim::Geant4ActionSD::readoutGeometry ( ) const
pure virtual

Access to the readout geometry of the sensitive detector.

Implemented in dd4hep::sim::Geant4SensDet.

◆ sensitiveDetector()

virtual SensitiveDetector dd4hep::sim::Geant4ActionSD::sensitiveDetector ( ) const
pure virtual

Access to the Detector sensitive detector handle.

Implemented in dd4hep::sim::Geant4SensDet.

◆ sensitiveType()

virtual const std::string& dd4hep::sim::Geant4ActionSD::sensitiveType ( ) const
pure virtual

Access to the sensitive type of the detector.

Implemented in dd4hep::sim::Geant4SensDet.


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