Default base class for all Geant 4 actions and derivates thereof. More...

#include <Geant4Action.h>

Inheritance diagram for dd4hep::sim::Geant4Action:

Classes
class	Actors
	Actor class to manipulate action groups. More...

class	ContextSwap
	Functor to update the context of a Geant4Action object. More...

struct	FindByName
	Functor to access elements by name. More...

Public Member Functions
	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 (Geant4Action)
	Define standard assignments and constructors. More...

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

Protected Attributes
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

Default base class for all Geant 4 actions and derivates thereof.

This is a utility class supporting properties, output and access to event and run objects through the context.

Author: M.Frank

Version: 1.0

Definition at line 113 of file Geant4Action.h.

Constructor & Destructor Documentation

◆ ~Geant4Action()

Geant4Action::~Geant4Action ( )

protectedvirtual

Default destructor.

Definition at line 66 of file Geant4Action.cpp.

◆ Geant4Action()

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

Standard constructor.

Definition at line 54 of file Geant4Action.cpp.

Member Function Documentation

◆ abortRun()

void Geant4Action::abortRun	(	const std::string &	exception,
		const char *	fmt,
			...
	)		const

Abort Geant4 Run by throwing a G4Exception with type RunMustBeAborted.

Definition at line 266 of file Geant4Action.cpp.

◆ addRef()

long Geant4Action::addRef ( )

Increase reference count.

Implicit destruction.

Definition at line 71 of file Geant4Action.cpp.

◆ always()

void Geant4Action::always	(	const char *	fmt,
			...
	)		const

Support of always printed messages.

Definition at line 199 of file Geant4Action.cpp.

◆ c_name()

const char* dd4hep::sim::Geant4Action::c_name ( ) const

inline

Access name of the action.

Definition at line 284 of file Geant4Action.h.

◆ configureFiber()

void Geant4Action::configureFiber ( Geant4Context * thread_context )

virtual

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

Definition at line 140 of file Geant4Action.cpp.

◆ context()

Geant4Context* dd4hep::sim::Geant4Action::context ( ) const

inline

Access the context.

Definition at line 270 of file Geant4Action.h.

◆ control()

Geant4UIMessenger * Geant4Action::control ( ) const

Access to the UI messenger.

Definition at line 125 of file Geant4Action.cpp.

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

dd4hep::sim::Geant4Action::DDG4_DEFINE_ACTION_CONSTRUCTORS ( Geant4Action )

protected

Define standard assignments and constructors.

◆ debug()

void Geant4Action::debug	(	const char *	fmt,
			...
	)		const

Support of debug messages.

Definition at line 207 of file Geant4Action.cpp.

◆ declareProperty() [1/2]

template<typename T >

Geant4Action & dd4hep::sim::Geant4Action::declareProperty	(	const char *	nam,
		T &	val
	)

Declare property.

Definition at line 372 of file Geant4Action.h.

◆ declareProperty() [2/2]

template<typename T >

Geant4Action & dd4hep::sim::Geant4Action::declareProperty	(	const std::string &	nam,
		T &	val
	)

Declare property.

Definition at line 366 of file Geant4Action.h.

◆ enableUI()

void Geant4Action::enableUI ( )

virtual

Enable and install UI messenger.

Reimplemented in dd4hep::sim::Geant4RunManager< RUNMANAGER >, and dd4hep::sim::Geant4RunManager< RUNMANAGER >.

Definition at line 134 of file Geant4Action.cpp.

◆ error()

void Geant4Action::error	(	const char *	fmt,
			...
	)		const

Support of error messages.

Action to support error messages.

Definition at line 231 of file Geant4Action.cpp.

◆ eventAction()

Geant4EventActionSequence & Geant4Action::eventAction ( ) const

Access to the main event action sequence from the kernel object.

Definition at line 283 of file Geant4Action.cpp.

◆ except()

void Geant4Action::except	(	const char *	fmt,
			...
	)		const

Support of exceptions: Print fatal message and throw runtime_error.

Definition at line 256 of file Geant4Action.cpp.

◆ fatal()

void Geant4Action::fatal	(	const char *	fmt,
			...
	)		const

Support of fatal messages. Throws exception.

Support of fatal messages. Throws exception if required.

Definition at line 248 of file Geant4Action.cpp.

◆ generatorAction()

Geant4GeneratorActionSequence & Geant4Action::generatorAction ( ) const

Access to the main generator action sequence from the kernel object.

Definition at line 303 of file Geant4Action.cpp.

◆ hasProperty()

bool Geant4Action::hasProperty ( const std::string & name ) const

Check property for existence.

Definition at line 94 of file Geant4Action.cpp.

◆ info()

void Geant4Action::info	(	const char *	fmt,
			...
	)		const

Support of info messages.

Definition at line 215 of file Geant4Action.cpp.

◆ installCommandMessenger()

void Geant4Action::installCommandMessenger ( )

virtual

Install command control messenger if wanted.

Reimplemented in dd4hep::sim::Geant4PhysicsListActionSequence, dd4hep::sim::Geant4PhysicsList, dd4hep::sim::Geant4DetectorGeometryConstruction, dd4hep::sim::Geant4GDMLWriteAction, and dd4hep::sim::Geant4UIManager.

Definition at line 121 of file Geant4Action.cpp.

◆ installMessengers()

void Geant4Action::installMessengers ( )

virtual

Install property control messenger if wanted.

Install all control messenger if wanted.

Definition at line 104 of file Geant4Action.cpp.

◆ installPropertyMessenger()

void Geant4Action::installPropertyMessenger ( )

virtual

Install property control messenger if wanted.

Definition at line 116 of file Geant4Action.cpp.

◆ name()

const std::string& dd4hep::sim::Geant4Action::name ( ) const

inline

Access name of the action.

Definition at line 280 of file Geant4Action.h.

◆ outputLevel()

PrintLevel dd4hep::sim::Geant4Action::outputLevel ( ) const

inline

Access the output level.

Definition at line 296 of file Geant4Action.h.

◆ print()

void Geant4Action::print	(	const char *	fmt,
			...
	)		const

Support for messages with variable output level using output level.

Definition at line 144 of file Geant4Action.cpp.

◆ printM1()

void Geant4Action::printM1	(	const char *	fmt,
			...
	)		const

Support for messages with variable output level using output level-1.

Definition at line 155 of file Geant4Action.cpp.

◆ printM2()

void Geant4Action::printM2	(	const char *	fmt,
			...
	)		const

Support for messages with variable output level using output level-2.

Definition at line 166 of file Geant4Action.cpp.

◆ printP1()

void Geant4Action::printP1	(	const char *	fmt,
			...
	)		const

Support for messages with variable output level using output level+1.

Support for messages with variable output level using output level-1.

Definition at line 177 of file Geant4Action.cpp.

◆ printP2()

void Geant4Action::printP2	(	const char *	fmt,
			...
	)		const

Support for messages with variable output level using output level+2.

Support for messages with variable output level using output level-2.

Definition at line 188 of file Geant4Action.cpp.

◆ properties()

PropertyManager& dd4hep::sim::Geant4Action::properties ( )

inline

Access to the properties of the object.

Definition at line 292 of file Geant4Action.h.

◆ property()

dd4hep::Property & Geant4Action::property ( const std::string & name )

Access single property.

Definition at line 99 of file Geant4Action.cpp.

◆ release()

long Geant4Action::release ( )

Decrease reference count. Implicit destruction.

Definition at line 76 of file Geant4Action.cpp.

◆ return_error()

bool Geant4Action::return_error	(	bool	return_value,
		const char *	fmt,
			...
	)		const

Action to support error messages.

Definition at line 239 of file Geant4Action.cpp.

◆ runAction()

Geant4RunActionSequence & Geant4Action::runAction ( ) const

Access to the main run action sequence from the kernel object.

Definition at line 278 of file Geant4Action.cpp.

◆ setName()

void dd4hep::sim::Geant4Action::setName ( const std::string & new_name )

inline

Set the object name.

Definition at line 288 of file Geant4Action.h.

◆ setOutputLevel()

dd4hep::PrintLevel Geant4Action::setOutputLevel ( PrintLevel new_level )

Set the output level; returns previous value.

Definition at line 87 of file Geant4Action.cpp.

◆ stackingAction()

Geant4StackingActionSequence & Geant4Action::stackingAction ( ) const

Access to the main stacking action sequence from the kernel object.

Definition at line 298 of file Geant4Action.cpp.

◆ steppingAction()

Geant4SteppingActionSequence & Geant4Action::steppingAction ( ) const

Access to the main stepping action sequence from the kernel object.

Definition at line 288 of file Geant4Action.cpp.

◆ trackingAction()

Geant4TrackingActionSequence & Geant4Action::trackingAction ( ) const

Access to the main tracking action sequence from the kernel object.

Definition at line 293 of file Geant4Action.cpp.

◆ updateContext()

virtual void dd4hep::sim::Geant4Action::updateContext ( Geant4Context * ctxt )

inlinevirtual

Set or update client context.

Reimplemented in dd4hep::sim::Geant4SensDetActionSequence, dd4hep::sim::Geant4DetectorConstructionSequence, dd4hep::sim::Geant4EventActionSequence, dd4hep::sim::Geant4StackingActionSequence, dd4hep::sim::Geant4RunActionSequence, dd4hep::sim::Geant4TrackingActionSequence, dd4hep::sim::Geant4GeneratorActionSequence, dd4hep::sim::Geant4SteppingActionSequence, and dd4hep::sim::Geant4UserInitializationSequence.

Definition at line 274 of file Geant4Action.h.

◆ warning()

void Geant4Action::warning	(	const char *	fmt,
			...
	)		const

Support of warning messages.

Definition at line 223 of file Geant4Action.cpp.

Member Data Documentation

◆ m_context

Geant4Context* dd4hep::sim::Geant4Action::m_context { nullptr }

protected

Reference to the Geant4 context.

Definition at line 116 of file Geant4Action.h.

◆ m_control

Geant4UIMessenger* dd4hep::sim::Geant4Action::m_control { nullptr }

protected

Control directory of this action.

Definition at line 118 of file Geant4Action.h.

◆ m_name

std::string dd4hep::sim::Geant4Action::m_name { }

protected

Action name.

Definition at line 125 of file Geant4Action.h.

◆ m_needsControl

bool dd4hep::sim::Geant4Action::m_needsControl { false }

protected

Default property: Flag to create control instance.

Definition at line 123 of file Geant4Action.h.

◆ m_outputLevel

int dd4hep::sim::Geant4Action::m_outputLevel { 3 }

protected

Default property: Output level.

Definition at line 121 of file Geant4Action.h.

◆ m_properties

PropertyManager dd4hep::sim::Geant4Action::m_properties { }

protected

Property pool.

Definition at line 127 of file Geant4Action.h.

◆ m_refCount

long dd4hep::sim::Geant4Action::m_refCount { 1 }

protected

Reference count. Initial value: 1.

Definition at line 129 of file Geant4Action.h.

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

DDG4/include/DDG4/Geant4Action.h
DDG4/src/Geant4Action.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Geant4Action()

◆ Geant4Action()

Member Function Documentation

◆ abortRun()

◆ addRef()

◆ always()

◆ c_name()

◆ configureFiber()

◆ context()

◆ control()

◆ DDG4_DEFINE_ACTION_CONSTRUCTORS()

◆ debug()

◆ declareProperty() [1/2]

◆ declareProperty() [2/2]

◆ enableUI()

◆ error()

◆ eventAction()

◆ except()

◆ fatal()

◆ generatorAction()

◆ hasProperty()

◆ info()

◆ installCommandMessenger()

◆ installMessengers()

◆ installPropertyMessenger()

◆ name()

◆ outputLevel()

◆ print()

◆ printM1()

◆ printM2()

◆ printP1()

◆ printP2()

◆ properties()

◆ property()

◆ release()

◆ return_error()

◆ runAction()

◆ setName()

◆ setOutputLevel()

◆ stackingAction()

◆ steppingAction()

◆ trackingAction()

◆ updateContext()

◆ warning()

Member Data Documentation

◆ m_context

◆ m_control

◆ m_name

◆ m_needsControl

◆ m_outputLevel

◆ m_properties

◆ m_refCount