DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Attributes | List of all members
dd4hep::sim::Test::Geant4TestSensitive Class Reference

Example sensitve detector action doing nothing, but print. More...

#include <Geant4TestActions.h>

Inheritance diagram for dd4hep::sim::Test::Geant4TestSensitive:
dd4hep::sim::Geant4Sensitive dd4hep::sim::Test::Geant4TestBase dd4hep::sim::Geant4Action

Public Member Functions

 Geant4TestSensitive (Geant4Context *c, const std::string &n, DetElement det, Detector &description)
 Standard constructor with initializing arguments. More...
 
virtual ~Geant4TestSensitive ()
 Default destructor. More...
 
virtual void begin (G4HCofThisEvent *) override
 Begin-of-tracking callback. More...
 
virtual void end (G4HCofThisEvent *) override
 End-of-tracking callback. More...
 
virtual bool process (const G4Step *, G4TouchableHistory *) override
 Method for generating hit(s) using the information of G4Step object. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4Sensitive
 Geant4Sensitive (Geant4Context *context, const std::string &name, DetElement det, Detector &description)
 Constructor. The sensitive detector element is identified by the detector name. More...
 
virtual ~Geant4Sensitive ()
 Standard destructor. More...
 
Geant4ActionSDdetector () const
 Access to the sensitive detector object. More...
 
void setDetector (Geant4ActionSD *sens_det)
 Access to the sensitive detector object. More...
 
int hitCreationMode () const
 Property access to the hit creation mode. More...
 
std::string detectorName () const
 G4VSensitiveDetector internals: Access to the detector name. More...
 
std::string path () const
 G4VSensitiveDetector internals: Access to the detector path name. More...
 
std::string fullPath () const
 G4VSensitiveDetector internals: Access to the detector path name. More...
 
bool isActive () const
 G4VSensitiveDetector internals: Is the detector active? More...
 
SensitiveDetector sensitiveDetector () const
 Access the dd4hep sensitive detector. More...
 
G4VReadOutGeometry * readoutGeometry () const
 Access to the readout geometry of the sensitive detector. More...
 
DetectordetectorDescription () const
 Access the detector desciption object. More...
 
void mark (const G4Track *track) const
 Mark the track to be kept for MC truth propagation during hit processing. More...
 
void mark (const G4Step *step) const
 Mark the track of this step to be kept for MC truth propagation during hit processing. More...
 
Geant4SensDetActionSequencesequence () const
 Access to the hosting sequence. More...
 
void adopt (Geant4Filter *filter)
 Add an actor responding to all callbacks. Sequence takes ownership. More...
 
void adopt_front (Geant4Filter *filter)
 Add an actor responding to all callbacks to the sequence front. Sequence takes ownership. More...
 
void adoptFilter (Geant4Action *filter)
 Add an actor responding to all callbacks. Sequence takes ownership. More...
 
void adoptFilter_front (Geant4Action *filter)
 Add an actor responding to all callbacks to the sequence front. Sequence takes ownership. More...
 
bool accept (const G4Step *step) const
 Callback before hit processing starts. Invoke all filters. More...
 
bool accept (const Geant4FastSimSpot *step) const
 GFLASH/FastSim interface: Callback before hit processing starts. Invoke all filters. More...
 
template<typename TYPE >
std::size_t defineCollection (const std::string &coll_name)
 Initialize the usage of a single hit collection. Returns the collection ID. More...
 
const std::string & hitCollectionName (std::size_t which) const
 Access HitCollection container names. More...
 
Geant4HitCollectioncollection (std::size_t which)
 Retrieve the hits collection associated with this detector by its serial number. More...
 
Geant4HitCollectioncollectionByID (std::size_t id)
 Retrieve the hits collection associated with this detector by its collection identifier. More...
 
virtual void defineCollections ()
 Define collections created by this sensitivie action object. More...
 
virtual void clear (G4HCofThisEvent *hce)
 G4VSensitiveDetector interface: Method invoked if the event was aborted. More...
 
long long int volumeID (const G4Step *step)
 Returns the volumeID of the sensitive volume corresponding to the step. More...
 
long long int volumeID (const G4VTouchable *touchable)
 Returns the volumeID of the sensitive volume corresponding to the G4VTouchable. More...
 
long long int cellID (const G4Step *step)
 Returns the cellID of the sensitive volume corresponding to the step. More...
 
long long int cellID (const G4VTouchable *touchable, const G4ThreeVector &global)
 Returns the cellID of the sensitive volume corresponding to the G4VTouchable. More...
 
virtual bool processFastSim (const Geant4FastSimSpot *spot, G4TouchableHistory *history)
 GFLASH/FastSim interface: Method for generating hit(s) using the information of the fast simulation spot object. 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...
 
- Public Member Functions inherited from dd4hep::sim::Test::Geant4TestBase
 Geant4TestBase (Geant4Action *action, const std::string &typ)
 Standard constructor. More...
 
virtual ~Geant4TestBase ()
 Default destructor. More...
 

Protected Attributes

size_t m_collectionID
 
- Protected Attributes inherited from dd4hep::sim::Geant4Sensitive
int m_hitCreationMode = 0
 Property: Hit creation mode. Maybe one of the enum HitCreationFlags. More...
 
Detectorm_detDesc
 Reference to the detector description object. More...
 
DetElement m_detector { }
 Reference to the detector element describing this sensitive element. More...
 
SensitiveDetector m_sensitive { }
 Reference to the sensitive detector element. More...
 
Readout m_readout { }
 Reference to the readout structure. More...
 
Segmentation m_segmentation { }
 Reference to segmentation. More...
 
Actors< Geant4Filterm_filters
 The list of sensitive detector filter objects. 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...
 
- Protected Attributes inherited from dd4hep::sim::Test::Geant4TestBase
int m_value1
 
double m_value2
 
std::string m_value3
 
std::string m_type
 

Additional Inherited Members

- Public Types inherited from dd4hep::sim::Geant4Sensitive
enum  HitCreationFlags { SIMPLE_MODE = 0, MEDIUM_MODE = 1<<0, DETAILED_MODE = 1<<1 }
 
- Protected Member Functions inherited from dd4hep::sim::Geant4Sensitive
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Sensitive)
 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...
 

Detailed Description

Example sensitve detector action doing nothing, but print.

Author
M.Frank
Version
1.0

Definition at line 177 of file Geant4TestActions.h.

Constructor & Destructor Documentation

◆ Geant4TestSensitive()

Geant4TestSensitive::Geant4TestSensitive ( Geant4Context c,
const std::string &  n,
DetElement  det,
Detector description 
)

Standard constructor with initializing arguments.

Definition at line 215 of file Geant4TestActions.cpp.

◆ ~Geant4TestSensitive()

Geant4TestSensitive::~Geant4TestSensitive ( )
virtual

Default destructor.

Definition at line 223 of file Geant4TestActions.cpp.

Member Function Documentation

◆ begin()

void Geant4TestSensitive::begin ( G4HCofThisEvent *  hce)
overridevirtual

Begin-of-tracking callback.

Reimplemented from dd4hep::sim::Geant4Sensitive.

Definition at line 228 of file Geant4TestActions.cpp.

◆ end()

void Geant4TestSensitive::end ( G4HCofThisEvent *  hce)
overridevirtual

End-of-tracking callback.

Reimplemented from dd4hep::sim::Geant4Sensitive.

Definition at line 236 of file Geant4TestActions.cpp.

◆ process()

bool Geant4TestSensitive::process ( const G4Step *  step,
G4TouchableHistory *   
)
overridevirtual

Method for generating hit(s) using the information of G4Step object.

Reimplemented from dd4hep::sim::Geant4Sensitive.

Definition at line 244 of file Geant4TestActions.cpp.

Member Data Documentation

◆ m_collectionID

size_t dd4hep::sim::Test::Geant4TestSensitive::m_collectionID
protected

Definition at line 179 of file Geant4TestActions.h.


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