Base class to initialize a multi-threaded or single threaded Geant4 application. More...

#include <Geant4PythonInitialization.h>

Inheritance diagram for dd4hep::sim::Geant4PythonInitialization:

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

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

void	setMasterSetup (PyObject callable, PyObject args)
	Set the Detector initialization command. More...

void	setWorkerSetup (PyObject callable, PyObject args)
	Set the field initialization command. More...

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

virtual void	buildMaster () const
	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	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
void	exec (const std::string &desc, const Geant4PythonCall &cmd) const
	Execute command in the python interpreter. 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
Geant4PythonCall	m_masterSetup
	Master initialization command. Default: empty. More...

Geant4PythonCall	m_workerSetup
	Worker initialization command. Default: empty. 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

Base class to initialize a multi-threaded or single threaded Geant4 application.

Geant4PythonInitialization allows to configure python callbacks for the master and the worker thread setup using the calls:

// Set the Detector initialization command void setMasterSetup(PyObject* callable, PyObject* args); // Set the field initialization command void setWorkerSetup(PyObject* callable, PyObject* args);

or in python as a call sequence within the master thread:

init_seq = kernel.userInitialization(True) init_action = UserInitialization(kernel,'Geant4PythonInitialization/PyG4Init') init_action.setWorkerSetup(worker_setup_call, < worker_args > ) init_action.setMasterSetup(master_setup_call, < master_args > ) init_seq.adopt(init_action)

The callback argument list worker_args and master_args are python tuples containing all arguments expected by the callbacks worker_setup_call and master_setup_call respecyively. The class Geant4PythonInitialization is a subclass of Geant4UserInitialization and will call the provided functions according to the protocol explained earlier in this section.

All python callbacks are supposed to return the integer '1' on success. Any other return code is assumed to be failure.