Base class to output Geant4 event data to persistent media. More...

#include <Geant4OutputAction.h>

Inheritance diagram for dd4hep::sim::Geant4OutputAction:

Classes
class	OutputContext
	Helper class for thread savety. More...

Public Member Functions
	Geant4OutputAction ()=delete
	Inhibit default constructor. More...

	Geant4OutputAction (const Geant4OutputAction &copy)=delete
	Inhibit copy constructor. More...

	Geant4OutputAction (Geant4Context *c, const std::string &nam)
	Standard constructor. More...

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

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

virtual void	begin (const G4Event *event) override
	begin-of-event callback More...

virtual void	end (const G4Event *event) override
	End-of-event callback. More...

virtual void	beginRun (const G4Run *run)
	Callback to initialize storing the Geant4 information. More...

virtual void	endRun (const G4Run *run)
	Callback to store the Geant4 run information. More...

virtual void	saveRun (const G4Run *run)
	Callback to store the Geant4 event. More...

virtual void	saveEvent (OutputContext< G4Event > &ctxt)
	Callback to store the Geant4 event. More...

virtual void	saveCollection (OutputContext< G4Event > &ctxt, G4VHitsCollection *collection)
	Callback to store each Geant4 hit collection. More...

virtual void	commit (OutputContext< G4Event > &ctxt)
	Commit data at end of filling procedure. More...

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

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

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
std::string	m_output { }
	Property: "Output" output destination. More...

bool	m_errorFatal { true }
	Property: "HandleErrorsAsFatal" Handle errors as fatal and rethrow eventual exceptions. More...

Geant4ParticleMap *	m_truth { nullptr }
	Reference to MC truth object. 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
Public Types inherited from dd4hep::sim::Geant4EventAction
typedef Geant4SharedEventAction	shared_type

Protected Member Functions inherited from dd4hep::sim::Geant4EventAction
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4EventAction)
	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...

Detailed Description

Base class to output Geant4 event data to persistent media.

Author: M.Frank

Version: 1.0

Definition at line 40 of file Geant4OutputAction.h.

Constructor & Destructor Documentation

◆ Geant4OutputAction() [1/3]

dd4hep::sim::Geant4OutputAction::Geant4OutputAction ( )

delete

Inhibit default constructor.

◆ Geant4OutputAction() [2/3]

dd4hep::sim::Geant4OutputAction::Geant4OutputAction ( const Geant4OutputAction & copy )

delete

Inhibit copy constructor.

◆ Geant4OutputAction() [3/3]

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

Standard constructor.

Definition at line 28 of file Geant4OutputAction.cpp.

◆ ~Geant4OutputAction()

Geant4OutputAction::~Geant4OutputAction ( )

virtual

Default destructor.

Definition at line 39 of file Geant4OutputAction.cpp.

Member Function Documentation

◆ begin()

void Geant4OutputAction::begin ( const G4Event * event )

overridevirtual

begin-of-event callback

Reimplemented from dd4hep::sim::Geant4EventAction.

Reimplemented in dd4hep::sim::Geant4Output2LCIO, and dd4hep::sim::Geant4Output2EDM4hep.

Definition at line 51 of file Geant4OutputAction.cpp.

◆ beginRun()

void Geant4OutputAction::beginRun ( const G4Run * run )

virtual

Callback to initialize storing the Geant4 information.

Callback to initialize the storing of the Geant4 information.

Reimplemented in dd4hep::sim::Geant4Output2ROOT, dd4hep::sim::Geant4Output2LCIO, and dd4hep::sim::Geant4Output2EDM4hep.

Definition at line 108 of file Geant4OutputAction.cpp.

◆ commit()

void Geant4OutputAction::commit ( OutputContext< G4Event > & ctxt )

virtual

Commit data at end of filling procedure.

Reimplemented in dd4hep::sim::Geant4Output2ROOT, dd4hep::sim::Geant4Output2LCIO, and dd4hep::sim::Geant4Output2EDM4hep.

Definition at line 104 of file Geant4OutputAction.cpp.

◆ configureFiber()

void Geant4OutputAction::configureFiber ( Geant4Context * ctxt )

overridevirtual

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

Set or update client for the use in a new thread fiber with seperate action sequences.

Reimplemented from dd4hep::sim::Geant4Action.

Definition at line 44 of file Geant4OutputAction.cpp.

◆ end()

void Geant4OutputAction::end ( const G4Event * event )

overridevirtual

End-of-event callback.

Reimplemented from dd4hep::sim::Geant4EventAction.

Definition at line 55 of file Geant4OutputAction.cpp.

◆ endRun()

void Geant4OutputAction::endRun ( const G4Run * run )

virtual

Callback to store the Geant4 run information.

Reimplemented in dd4hep::sim::Geant4Output2LCIO, and dd4hep::sim::Geant4Output2EDM4hep.

Definition at line 112 of file Geant4OutputAction.cpp.

◆ saveCollection()

void Geant4OutputAction::saveCollection	(	OutputContext< G4Event > &	ctxt,
		G4VHitsCollection *	collection
	)

virtual

Callback to store each Geant4 hit collection.

Reimplemented in dd4hep::sim::Geant4Output2ROOT, dd4hep::sim::Geant4Output2LCIO, and dd4hep::sim::Geant4Output2EDM4hep.

Definition at line 124 of file Geant4OutputAction.cpp.

◆ saveEvent()

void Geant4OutputAction::saveEvent ( OutputContext< G4Event > & ctxt )

virtual

Callback to store the Geant4 event.

Reimplemented in dd4hep::sim::Geant4Output2ROOT, dd4hep::sim::Geant4Output2LCIO, and dd4hep::sim::Geant4Output2EDM4hep.

Definition at line 120 of file Geant4OutputAction.cpp.

◆ saveRun()

void Geant4OutputAction::saveRun ( const G4Run * run )

virtual

Callback to store the Geant4 event.

Callback to store the Geant4 run information.

Reimplemented in dd4hep::sim::Geant4Output2LCIO, and dd4hep::sim::Geant4Output2EDM4hep.

Definition at line 116 of file Geant4OutputAction.cpp.

Member Data Documentation

◆ m_errorFatal

bool dd4hep::sim::Geant4OutputAction::m_errorFatal { true }

protected

Property: "HandleErrorsAsFatal" Handle errors as fatal and rethrow eventual exceptions.

Definition at line 58 of file Geant4OutputAction.h.

◆ m_output

std::string dd4hep::sim::Geant4OutputAction::m_output { }

protected

Property: "Output" output destination.

Definition at line 56 of file Geant4OutputAction.h.

◆ m_truth

Geant4ParticleMap* dd4hep::sim::Geant4OutputAction::m_truth { nullptr }

protected

Reference to MC truth object.

Definition at line 60 of file Geant4OutputAction.h.

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

DDG4/include/DDG4/Geant4OutputAction.h
DDG4/src/Geant4OutputAction.cpp

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Geant4OutputAction() [1/3]

◆ Geant4OutputAction() [2/3]

◆ Geant4OutputAction() [3/3]

◆ ~Geant4OutputAction()

Member Function Documentation

◆ begin()

◆ beginRun()

◆ commit()

◆ configureFiber()

◆ end()

◆ endRun()

◆ saveCollection()

◆ saveEvent()

◆ saveRun()

Member Data Documentation

◆ m_errorFatal

◆ m_output

◆ m_truth