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

#include <Geant4GeneratorAction.h>

Inheritance diagram for dd4hep::sim::Geant4GeneratorActionSequence:

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

virtual	~Geant4GeneratorActionSequence ()
	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...

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

template<typename Q , typename T >
void	call (Q p, void(T::f)(G4Event *))
	Register primary particle generation callback. Types Q and T must be polymorph! More...

void	adopt (Geant4GeneratorAction *action)
	Add an actor responding to all callbacks. Sequence takes ownership. More...

virtual void	operator() (G4Event *event)
	Callback to generate primary particles. 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 (Geant4GeneratorActionSequence)
	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_calls
	Callback sequence to generate primary particles. More...

Actors< Geant4GeneratorAction >	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 generator action sequence.

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

The callback signature is: void operator()(G4Event* event)

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 115 of file Geant4GeneratorAction.h.

Constructor & Destructor Documentation

◆ Geant4GeneratorActionSequence()

Geant4GeneratorActionSequence::Geant4GeneratorActionSequence	(	Geant4Context *	context,
		const std::string &	name
	)

Standard constructor.

Definition at line 79 of file Geant4GeneratorAction.cpp.

◆ ~Geant4GeneratorActionSequence()

Geant4GeneratorActionSequence::~Geant4GeneratorActionSequence ( )

virtual

Default destructor.

Definition at line 86 of file Geant4GeneratorAction.cpp.

Member Function Documentation

◆ adopt()

void Geant4GeneratorActionSequence::adopt ( Geant4GeneratorAction * action )

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

Definition at line 110 of file Geant4GeneratorAction.cpp.

◆ call()

template<typename Q , typename T >

void dd4hep::sim::Geant4GeneratorActionSequence::call	(	Q *	p,
		void(T::)(G4Event )	f
	)

inline

Register primary particle generation callback. Types Q and T must be polymorph!

Definition at line 137 of file Geant4GeneratorAction.h.

◆ configureFiber()

void Geant4GeneratorActionSequence::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 100 of file Geant4GeneratorAction.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4GeneratorActionSequence::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4GeneratorActionSequence )

protected

Define standard assignments and constructors.

◆ get()

Geant4GeneratorAction * Geant4GeneratorActionSequence::get ( const std::string & name ) const

Get an action by name.

Definition at line 105 of file Geant4GeneratorAction.cpp.

◆ operator()()

void Geant4GeneratorActionSequence::operator() ( G4Event * event )

virtual

Callback to generate primary particles.

Generator callback.

Definition at line 121 of file Geant4GeneratorAction.cpp.

◆ updateContext()

void Geant4GeneratorActionSequence::updateContext ( Geant4Context * ctxt )

overridevirtual

Set or update client context.

Reimplemented from dd4hep::sim::Geant4Action.

Definition at line 94 of file Geant4GeneratorAction.cpp.

Member Data Documentation

◆ m_actors

Actors<Geant4GeneratorAction> dd4hep::sim::Geant4GeneratorActionSequence::m_actors

protected

The list of action objects to be called.

Definition at line 120 of file Geant4GeneratorAction.h.

◆ m_calls

CallbackSequence dd4hep::sim::Geant4GeneratorActionSequence::m_calls

protected

Callback sequence to generate primary particles.

Definition at line 118 of file Geant4GeneratorAction.h.

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

DDG4/include/DDG4/Geant4GeneratorAction.h
DDG4/src/Geant4GeneratorAction.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Geant4GeneratorActionSequence()

◆ ~Geant4GeneratorActionSequence()

Member Function Documentation

◆ adopt()

◆ call()

◆ configureFiber()

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

◆ get()

◆ operator()()

◆ updateContext()

Member Data Documentation

◆ m_actors

◆ m_calls