Concrete basic implementation of the Geant4 event action. More...

#include <Geant4EventAction.h>

Inheritance diagram for dd4hep::sim::Geant4EventAction:

Public Types
typedef Geant4SharedEventAction	shared_type

Public Member Functions
	Geant4EventAction (Geant4Context *context, const std::string &nam)
	Standard constructor. More...

virtual	~Geant4EventAction ()
	Default destructor. More...

virtual void	begin (const G4Event *event)
	Begin-of-event callback. More...

virtual void	end (const G4Event *event)
	End-of-event callback. 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...

Geant4Context *	context () 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...

PropertyManager &	properties ()
	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...

Geant4UIMessenger *	control () const
	Access to the UI messenger. More...

virtual void	enableUI ()
	Enable and install UI messenger. More...

template<typename T >
Geant4Action &	declareProperty (const std::string &nam, T &val)
	Declare property. More...

template<typename T >
Geant4Action &	declareProperty (const char *nam, T &val)
	Declare property. More...

bool	hasProperty (const std::string &name) const
	Check property for existence. More...

Property &	property (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...

Geant4RunActionSequence &	runAction () const
	Access to the main run action sequence from the kernel object. More...

Geant4EventActionSequence &	eventAction () const
	Access to the main event action sequence from the kernel object. More...

Geant4SteppingActionSequence &	steppingAction () const
	Access to the main stepping action sequence from the kernel object. More...

Geant4TrackingActionSequence &	trackingAction () const
	Access to the main tracking action sequence from the kernel object. More...

Geant4StackingActionSequence &	stackingAction () const
	Access to the main stacking action sequence from the kernel object. More...

Geant4GeneratorActionSequence &	generatorAction () const
	Access to the main generator action sequence from the kernel object. More...

Protected Member Functions
	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...

Additional Inherited Members
Protected Attributes inherited from dd4hep::sim::Geant4Action
Geant4Context *	m_context { nullptr }
	Reference to the Geant4 context. More...

Geant4UIMessenger *	m_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 basic implementation of the Geant4 event action.

The EventAction is called for every event.

This class is the base class for all user actions, which have to hook into the begin- and end-of-event actions. Typical use cases are the collection/computation of event related properties.

Examples of this functionality may include for example:

Reset variables summing event related information in the begin-event callback.
Monitoring activities such as filling histograms from hits collected during the end-event action.

Author
M.Frank

Version
1.0

Definition at line 53 of file Geant4EventAction.h.

Member Typedef Documentation

◆ shared_type

typedef Geant4SharedEventAction dd4hep::sim::Geant4EventAction::shared_type

Definition at line 55 of file Geant4EventAction.h.

Constructor & Destructor Documentation

◆ Geant4EventAction()

Geant4EventAction::Geant4EventAction	(	Geant4Context *	context,
		const std::string &	nam
	)

Standard constructor.

Definition at line 29 of file Geant4EventAction.cpp.

◆ ~Geant4EventAction()

Geant4EventAction::~Geant4EventAction ( )

virtual

Default destructor.

Definition at line 36 of file Geant4EventAction.cpp.

Member Function Documentation

◆ begin()

void Geant4EventAction::begin ( const G4Event * event )

virtual

Begin-of-event callback.

begin-of-event callback

Reimplemented in dd4hep::sim::Geant4SharedEventAction, dd4hep::sim::Geant4OutputAction, dd4hep::sim::Geant4ParticlePrint, dd4hep::sim::Geant4HitDumpAction, dd4hep::sim::Geant4HitTruthHandler, dd4hep::sim::Geant4ParticleDumpAction, dd4hep::sim::Geant4Output2LCIO, dd4hep::sim::Geant4Output2EDM4hep, dd4hep::sim::Geant4SurfaceTest, and dd4hep::sim::Test::Geant4TestEventAction.

Definition at line 41 of file Geant4EventAction.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4EventAction::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4EventAction )

protected

Define standard assignments and constructors.

◆ end()

void Geant4EventAction::end ( const G4Event * event )

virtual

End-of-event callback.

Reimplemented in dd4hep::sim::Geant4SharedEventAction, dd4hep::sim::Geant4OutputAction, dd4hep::sim::Geant4ParticlePrint, dd4hep::sim::Geant4HitDumpAction, dd4hep::sim::Geant4HitTruthHandler, dd4hep::sim::Geant4ParticleDumpAction, dd4hep::sim::Geant4SurfaceTest, and dd4hep::sim::Test::Geant4TestEventAction.

Definition at line 45 of file Geant4EventAction.cpp.

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

DDG4/include/DDG4/Geant4EventAction.h
DDG4/src/Geant4EventAction.cpp

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ shared_type

Constructor & Destructor Documentation

◆ Geant4EventAction()

◆ ~Geant4EventAction()

Member Function Documentation

◆ begin()

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

◆ end()