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

#include <Geant4EventAction.h>

Inheritance diagram for dd4hep::sim::Geant4EventActionSequence:

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

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

virtual void	updateContext (Geant4Context *ctxt) override
	Set or update client context. More...

virtual void	configureFiber (Geant4Context *thread_context) override
	Set or update client for the use in a new thread fiber. More...

Geant4EventAction *	get (const std::string &name) const
	Get an action by name. More...

template<typename Q , typename T >
void	callAtBegin (Q p, void(T::f)(const G4Event *))
	Register begin-of-event callback. More...

template<typename Q , typename T >
void	callAtEnd (Q p, void(T::f)(const G4Event *))
	Register end-of-event callback. More...

template<typename Q , typename T >
void	callAtFinal (Q p, void(T::f)(const G4Event *))
	Register event-cleanup callback (after end-of-event callback – unordered) More...

void	adopt (Geant4EventAction *action)
	Add an actor responding to all callbacks. Sequence takes ownership. 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...

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 (Geant4EventActionSequence)
	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
CallbackSequence	m_begin
	Callback sequence for event initialization action. More...

CallbackSequence	m_end
	Callback sequence for event finalization action. More...

CallbackSequence	m_final
	Callback sequence for event finalization action. More...

Actors< Geant4EventAction >	m_actors
	The list of action objects to be called. More...

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 implementation of the Geant4 event action sequence.

The sequence dispatches the callbacks at the beginning and the and of an event to all registered Geant4EventAction members and all registered callbacks.

Note Multi-Threading issue: Neither callbacks not the action list is protected against multiple threads calling the Geant4 callbacks! These must be protected in the user actions themselves.

Author: M.Frank

Version: 1.0

Definition at line 124 of file Geant4EventAction.h.

Constructor & Destructor Documentation

◆ Geant4EventActionSequence()

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

Standard constructor.

Definition at line 98 of file Geant4EventAction.cpp.

◆ ~Geant4EventActionSequence()

Geant4EventActionSequence::~Geant4EventActionSequence ( )

virtual

Default destructor.

Definition at line 105 of file Geant4EventAction.cpp.

Member Function Documentation

◆ adopt()

void Geant4EventActionSequence::adopt ( Geant4EventAction * action )

Add an actor responding to all callbacks. Sequence takes ownership.

Definition at line 131 of file Geant4EventAction.cpp.

◆ begin()

void Geant4EventActionSequence::begin ( const G4Event * event )

virtual

Begin-of-event callback.

Pre-track action callback.

Definition at line 142 of file Geant4EventAction.cpp.

◆ callAtBegin()

template<typename Q , typename T >

void dd4hep::sim::Geant4EventActionSequence::callAtBegin	(	Q *	p,
		void(T::)(const G4Event )	f
	)

inline

Register begin-of-event callback.

Definition at line 152 of file Geant4EventAction.h.

◆ callAtEnd()

template<typename Q , typename T >

void dd4hep::sim::Geant4EventActionSequence::callAtEnd	(	Q *	p,
		void(T::)(const G4Event )	f
	)

inline

Register end-of-event callback.

Definition at line 157 of file Geant4EventAction.h.

◆ callAtFinal()

template<typename Q , typename T >

void dd4hep::sim::Geant4EventActionSequence::callAtFinal	(	Q *	p,
		void(T::)(const G4Event )	f
	)

inline

Register event-cleanup callback (after end-of-event callback – unordered)

Definition at line 162 of file Geant4EventAction.h.

◆ configureFiber()

void Geant4EventActionSequence::configureFiber ( Geant4Context * thread_context )

overridevirtual

Set or update client for the use in a new thread fiber.

Reimplemented from dd4hep::sim::Geant4Action.

Definition at line 121 of file Geant4EventAction.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4EventActionSequence::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4EventActionSequence )

protected

Define standard assignments and constructors.

◆ end()

void Geant4EventActionSequence::end ( const G4Event * event )

virtual

End-of-event callback.

Post-track action callback.

Definition at line 148 of file Geant4EventAction.cpp.

◆ get()

Geant4EventAction * Geant4EventActionSequence::get ( const std::string & name ) const

Get an action by name.

Definition at line 126 of file Geant4EventAction.cpp.

◆ updateContext()

void Geant4EventActionSequence::updateContext ( Geant4Context * ctxt )

overridevirtual

Set or update client context.

Reimplemented from dd4hep::sim::Geant4Action.

Definition at line 115 of file Geant4EventAction.cpp.

Member Data Documentation

◆ m_actors

Actors<Geant4EventAction> dd4hep::sim::Geant4EventActionSequence::m_actors

protected

The list of action objects to be called.

Definition at line 133 of file Geant4EventAction.h.

◆ m_begin

CallbackSequence dd4hep::sim::Geant4EventActionSequence::m_begin

protected

Callback sequence for event initialization action.

Definition at line 127 of file Geant4EventAction.h.

◆ m_end

CallbackSequence dd4hep::sim::Geant4EventActionSequence::m_end

protected

Callback sequence for event finalization action.

Definition at line 129 of file Geant4EventAction.h.

◆ m_final

CallbackSequence dd4hep::sim::Geant4EventActionSequence::m_final

protected

Callback sequence for event finalization action.

Definition at line 131 of file Geant4EventAction.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Geant4EventActionSequence()

◆ ~Geant4EventActionSequence()

Member Function Documentation

◆ adopt()

◆ begin()

◆ callAtBegin()

◆ callAtEnd()

◆ callAtFinal()

◆ configureFiber()

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

◆ end()

◆ get()

◆ updateContext()

Member Data Documentation

◆ m_actors

◆ m_begin

◆ m_end

◆ m_final