Class to orchestrate a modular initializion of a multi- or single threaded Geant4 application. More...

#include <Geant4UserInitialization.h>

Inheritance diagram for dd4hep::sim::Geant4UserInitializationSequence:

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

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

template<typename Q , typename T >
void	build (Q p, void(T::f)())
	Register callback to setup worker. Types Q and T must be polymorph! More...

template<typename Q , typename T >
void	buildMaster (Q p, void(T::f)())
	Register callback to setup master. Types Q and T must be polymorph! More...

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

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

virtual void	build () const override
	Callback function to build setup for the MT worker thread. More...

virtual void	buildMaster () const override
	Callback function to build setup for the MT master thread. More...

Public Member Functions inherited from dd4hep::sim::Geant4UserInitialization
	Geant4UserInitialization (Geant4Context *c, const std::string &nam)
	Standard constructor. More...

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

Geant4Context *	context () const
	Access the 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 Attributes
CallbackSequence	m_masterCalls
	Callback sequence to initialize the thread master. More...

CallbackSequence	m_workerCalls
	Callback sequence to initialize worker elements. More...

Actors< Geant4UserInitialization >	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...

Additional Inherited Members
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

Class to orchestrate a modular initializion of a multi- or single threaded Geant4 application.

Author: M.Frank

Version: 1.0

Definition at line 52 of file Geant4UserInitialization.h.

Constructor & Destructor Documentation

◆ Geant4UserInitializationSequence()

Geant4UserInitializationSequence::Geant4UserInitializationSequence	(	Geant4Context *	c,
		const std::string &	nam
	)

Standard constructor.

Definition at line 41 of file Geant4UserInitialization.cpp.

◆ ~Geant4UserInitializationSequence()

Geant4UserInitializationSequence::~Geant4UserInitializationSequence ( )

virtual

Default destructor.

Definition at line 48 of file Geant4UserInitialization.cpp.

Member Function Documentation

◆ adopt()

void Geant4UserInitializationSequence::adopt ( Geant4UserInitialization * action )

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

Definition at line 57 of file Geant4UserInitialization.cpp.

◆ build() [1/2]

void Geant4UserInitializationSequence::build ( ) const

overridevirtual

Callback function to build setup for the MT worker thread.

Reimplemented from dd4hep::sim::Geant4UserInitialization.

Definition at line 67 of file Geant4UserInitialization.cpp.

◆ build() [2/2]

template<typename Q , typename T >

void dd4hep::sim::Geant4UserInitializationSequence::build	(	Q *	p,
		void(T::*)()	f
	)

inline

Register callback to setup worker. Types Q and T must be polymorph!

Definition at line 67 of file Geant4UserInitialization.h.

◆ buildMaster() [1/2]

void Geant4UserInitializationSequence::buildMaster ( ) const

overridevirtual

Callback function to build setup for the MT master thread.

Reimplemented from dd4hep::sim::Geant4UserInitialization.

Definition at line 73 of file Geant4UserInitialization.cpp.

◆ buildMaster() [2/2]

template<typename Q , typename T >

void dd4hep::sim::Geant4UserInitializationSequence::buildMaster	(	Q *	p,
		void(T::*)()	f
	)

inline

Register callback to setup master. Types Q and T must be polymorph!

Definition at line 71 of file Geant4UserInitialization.h.

◆ updateContext()

void Geant4UserInitializationSequence::updateContext ( Geant4Context * ctxt )

overridevirtual

Set client context.

Reimplemented from dd4hep::sim::Geant4Action.

Definition at line 79 of file Geant4UserInitialization.cpp.

Member Data Documentation

◆ m_actors

Actors<Geant4UserInitialization> dd4hep::sim::Geant4UserInitializationSequence::m_actors

protected

The list of action objects to be called.

Definition at line 59 of file Geant4UserInitialization.h.

◆ m_masterCalls

CallbackSequence dd4hep::sim::Geant4UserInitializationSequence::m_masterCalls

protected

Callback sequence to initialize the thread master.

Definition at line 55 of file Geant4UserInitialization.h.

◆ m_workerCalls

CallbackSequence dd4hep::sim::Geant4UserInitializationSequence::m_workerCalls

protected

Callback sequence to initialize worker elements.

Definition at line 57 of file Geant4UserInitialization.h.

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

DDG4/include/DDG4/Geant4UserInitialization.h
DDG4/src/Geant4UserInitialization.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geant4UserInitializationSequence()

◆ ~Geant4UserInitializationSequence()

Member Function Documentation

◆ adopt()

◆ build() [1/2]

◆ build() [2/2]

◆ buildMaster() [1/2]

◆ buildMaster() [2/2]

◆ updateContext()

Member Data Documentation

◆ m_actors

◆ m_masterCalls

◆ m_workerCalls