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

Default base class for all geant 4 tracking actions. More...

#include <Geant4ReadoutVolumeFilter.h>

Inheritance diagram for dd4hep::sim::Geant4ReadoutVolumeFilter:
dd4hep::sim::Geant4Filter dd4hep::sim::Geant4Action

Public Member Functions

 Geant4ReadoutVolumeFilter (Geant4Context *context, const std::string &name, Readout ro, const std::string &coll)
 Standard constructor. More...
 
virtual ~Geant4ReadoutVolumeFilter ()
 Default destructor. More...
 
virtual bool operator() (const G4Step *step) const override
 Filter action. Return true if hits should be processed. More...
 
virtual bool operator() (const Geant4FastSimSpot *step) const override
 GFLASH/FastSim interface: Filter action. Return true if hits should be processed. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4Filter
 Geant4Filter (Geant4Context *context, const std::string &name)
 Standard constructor. More...
 
virtual ~Geant4Filter ()
 Standard 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...
 
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 Attributes

Readout m_readout
 Reference to readout descriptor. More...
 
const HitCollectionm_collection
 Collection index. More...
 
const BitFieldElement * m_key
 Bit field value from ID descriptor. 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

- Protected Member Functions inherited from dd4hep::sim::Geant4Filter
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4Filter)
 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

Default base class for all geant 4 tracking actions.

Author
M.Frank
Version
1.0

Definition at line 33 of file Geant4ReadoutVolumeFilter.h.

Constructor & Destructor Documentation

◆ Geant4ReadoutVolumeFilter()

Geant4ReadoutVolumeFilter::Geant4ReadoutVolumeFilter ( Geant4Context context,
const std::string &  name,
Readout  ro,
const std::string &  coll 
)

Standard constructor.

Definition at line 27 of file Geant4ReadoutVolumeFilter.cpp.

◆ ~Geant4ReadoutVolumeFilter()

Geant4ReadoutVolumeFilter::~Geant4ReadoutVolumeFilter ( )
virtual

Default destructor.

Definition at line 47 of file Geant4ReadoutVolumeFilter.cpp.

Member Function Documentation

◆ operator()() [1/2]

bool Geant4ReadoutVolumeFilter::operator() ( const G4Step *  step) const
overridevirtual

Filter action. Return true if hits should be processed.

Reimplemented from dd4hep::sim::Geant4Filter.

Definition at line 52 of file Geant4ReadoutVolumeFilter.cpp.

◆ operator()() [2/2]

bool Geant4ReadoutVolumeFilter::operator() ( const Geant4FastSimSpot step) const
overridevirtual

GFLASH/FastSim interface: Filter action. Return true if hits should be processed.

Reimplemented from dd4hep::sim::Geant4Filter.

Definition at line 63 of file Geant4ReadoutVolumeFilter.cpp.

Member Data Documentation

◆ m_collection

const HitCollection* dd4hep::sim::Geant4ReadoutVolumeFilter::m_collection
protected

Collection index.

Definition at line 38 of file Geant4ReadoutVolumeFilter.h.

◆ m_key

const BitFieldElement* dd4hep::sim::Geant4ReadoutVolumeFilter::m_key
protected

Bit field value from ID descriptor.

Definition at line 40 of file Geant4ReadoutVolumeFilter.h.

◆ m_readout

Readout dd4hep::sim::Geant4ReadoutVolumeFilter::m_readout
protected

Reference to readout descriptor.

Definition at line 36 of file Geant4ReadoutVolumeFilter.h.


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