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

Geant4Action to print MC particle information. More...

#include <Geant4ParticlePrint.h>

Inheritance diagram for dd4hep::sim::Geant4ParticlePrint:
dd4hep::sim::Geant4EventAction dd4hep::sim::Geant4Action

Public Types

typedef Geant4ParticleMap::Particle Particle
 
typedef Geant4ParticleMap::ParticleMap ParticleMap
 
typedef Geant4ParticleMap::TrackEquivalents TrackEquivalents
 
- Public Types inherited from dd4hep::sim::Geant4EventAction
typedef Geant4SharedEventAction shared_type
 

Public Member Functions

 Geant4ParticlePrint (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4ParticlePrint ()
 Default destructor. More...
 
virtual void begin (const G4Event *event) override
 Pre-event action callback. More...
 
virtual void end (const G4Event *event) override
 Post-event action callback. More...
 
virtual void operator() (G4Event *event)
 Generation action callback. More...
 
- Public Member Functions inherited from dd4hep::sim::Geant4EventAction
 Geant4EventAction (Geant4Context *context, const std::string &nam)
 Standard constructor. More...
 
virtual ~Geant4EventAction ()
 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...
 
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

void printParticle (const std::string &prefix, const G4Event *e, Geant4ParticleHandle p) const
 
void printParticles (const G4Event *e, const ParticleMap &particles) const
 Print record of kept particles. More...
 
void printParticleTree (const G4Event *e, const ParticleMap &particles, int level, Geant4ParticleHandle p) const
 Print tree of kept particles. More...
 
void printParticleTree (const G4Event *e, const ParticleMap &particles) const
 Print tree of kept particles. More...
 
void makePrintout (const G4Event *e) const
 Print particle table. More...
 
- Protected Member Functions inherited from dd4hep::sim::Geant4EventAction
 DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4EventAction)
 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

int m_outputType
 Property: Flag to indicate output type: 1: TABLE, 2:TREE, 3:BOTH (default) More...
 
bool m_printBegin
 Property: Flag to indicate output type at begin of event. More...
 
bool m_printEnd
 Property: Flag to indicate output type at end of event. More...
 
bool m_printGeneration
 Property: Flag to indicate output type as part of the generator action. More...
 
bool m_printHits
 Property: Flag to indicate output of hit data in tree. 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

Geant4Action to print MC particle information.

Author
M.Frank
Version
1.0

Definition at line 38 of file Geant4ParticlePrint.h.

Member Typedef Documentation

◆ Particle

Definition at line 40 of file Geant4ParticlePrint.h.

◆ ParticleMap

Definition at line 41 of file Geant4ParticlePrint.h.

◆ TrackEquivalents

Definition at line 42 of file Geant4ParticlePrint.h.

Constructor & Destructor Documentation

◆ Geant4ParticlePrint()

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

Standard constructor.

Definition at line 32 of file Geant4ParticlePrint.cpp.

◆ ~Geant4ParticlePrint()

Geant4ParticlePrint::~Geant4ParticlePrint ( )
virtual

Default destructor.

Definition at line 44 of file Geant4ParticlePrint.cpp.

Member Function Documentation

◆ begin()

void Geant4ParticlePrint::begin ( const G4Event *  event)
overridevirtual

Pre-event action callback.

Reimplemented from dd4hep::sim::Geant4EventAction.

Definition at line 67 of file Geant4ParticlePrint.cpp.

◆ end()

void Geant4ParticlePrint::end ( const G4Event *  event)
overridevirtual

Post-event action callback.

Reimplemented from dd4hep::sim::Geant4EventAction.

Definition at line 72 of file Geant4ParticlePrint.cpp.

◆ makePrintout()

void Geant4ParticlePrint::makePrintout ( const G4Event *  e) const
protected

Print particle table.

Definition at line 49 of file Geant4ParticlePrint.cpp.

◆ operator()()

void Geant4ParticlePrint::operator() ( G4Event *  event)
virtual

Generation action callback.

Definition at line 62 of file Geant4ParticlePrint.cpp.

◆ printParticle()

void Geant4ParticlePrint::printParticle ( const std::string &  prefix,
const G4Event *  e,
Geant4ParticleHandle  p 
) const
protected

Definition at line 76 of file Geant4ParticlePrint.cpp.

◆ printParticles()

void Geant4ParticlePrint::printParticles ( const G4Event *  e,
const ParticleMap particles 
) const
protected

Print record of kept particles.

Definition at line 155 of file Geant4ParticlePrint.cpp.

◆ printParticleTree() [1/2]

void Geant4ParticlePrint::printParticleTree ( const G4Event *  e,
const ParticleMap particles 
) const
protected

Print tree of kept particles.

Definition at line 218 of file Geant4ParticlePrint.cpp.

◆ printParticleTree() [2/2]

void Geant4ParticlePrint::printParticleTree ( const G4Event *  e,
const ParticleMap particles,
int  level,
Geant4ParticleHandle  p 
) const
protected

Print tree of kept particles.

Definition at line 187 of file Geant4ParticlePrint.cpp.

Member Data Documentation

◆ m_outputType

int dd4hep::sim::Geant4ParticlePrint::m_outputType
protected

Property: Flag to indicate output type: 1: TABLE, 2:TREE, 3:BOTH (default)

Definition at line 45 of file Geant4ParticlePrint.h.

◆ m_printBegin

bool dd4hep::sim::Geant4ParticlePrint::m_printBegin
protected

Property: Flag to indicate output type at begin of event.

Definition at line 47 of file Geant4ParticlePrint.h.

◆ m_printEnd

bool dd4hep::sim::Geant4ParticlePrint::m_printEnd
protected

Property: Flag to indicate output type at end of event.

Definition at line 49 of file Geant4ParticlePrint.h.

◆ m_printGeneration

bool dd4hep::sim::Geant4ParticlePrint::m_printGeneration
protected

Property: Flag to indicate output type as part of the generator action.

Definition at line 51 of file Geant4ParticlePrint.h.

◆ m_printHits

bool dd4hep::sim::Geant4ParticlePrint::m_printHits
protected

Property: Flag to indicate output of hit data in tree.

Definition at line 53 of file Geant4ParticlePrint.h.


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