Generic input action capable of using the Geant4EventReader class. More...

#include <Geant4InputAction.h>

Inheritance diagram for dd4hep::sim::Geant4InputAction:

Public Types
typedef Geant4Vertex	Vertex

typedef Geant4Particle	Particle

typedef std::vector< Particle * >	Particles

typedef std::vector< Vertex * >	Vertices

using	PropertyMask = dd4hep::detail::ReferenceBitMask< int >

Public Types inherited from dd4hep::sim::Geant4GeneratorAction
typedef Geant4SharedGeneratorAction	shared_type

Public Member Functions
int	readParticles (int event_number, Vertices &vertices, Particles &particles)
	Read an event and return a LCCollectionVec of MCParticles. More...

void	setGeneratorStatus (int generatorStatus, PropertyMask &status)
	Convert the generator status into a common set of generator status bits. More...

std::string	issue (int i) const
	helper to report Geant4 exceptions More...

	Geant4InputAction (Geant4Context *context, const std::string &name)
	Standard constructor. More...

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

Particles *	new_particles () const
	Create particle vector. More...

virtual void	operator() (G4Event *event) override
	Callback to generate primary particles. More...

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

virtual	~Geant4GeneratorAction ()
	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	beginRun (const G4Run *)
	Perform some actions before the run starts, like opening the event inputs. More...

void	createReader ()
	Create the input reader. More...

Protected Member Functions inherited from dd4hep::sim::Geant4GeneratorAction
	DDG4_DEFINE_ACTION_CONSTRUCTORS (Geant4GeneratorAction)
	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
std::string	m_input
	Property: input file. More...

int	m_firstEvent
	Property: SYNCEVT. More...

int	m_mask
	Property; interaction mask. More...

double	m_momScale
	Property: Momentum downscaler for debugging. More...

Geant4EventReader *	m_reader
	Event reader object. More...

int	m_currentEventNumber
	current event number without initially skipped events More...

bool	m_abort
	Flag to call abortEvent in case of failure (default: true) More...

std::map< std::string, std::string >	m_parameters
	Property: named parameters to configure file readers or input actions. More...

std::set< int >	m_alternativeDecayStatuses = {}
	Property: set of alternative decay statuses that MC generators might use for unstable particles. More...

Protected Attributes inherited from dd4hep::sim::Geant4GeneratorAction
Callback	m_calls

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

Generic input action capable of using the Geant4EventReader class.

Concrete implementation of the Geant4 generator action base class populating Geant4 primaries from Geant4 and HepStd files.

Author: P.Kostka (main author); M.Frank (code reshuffeling into new DDG4 scheme)

Version: 1.0

Definition at line 157 of file Geant4InputAction.h.

Member Typedef Documentation

◆ Particle

typedef Geant4Particle dd4hep::sim::Geant4InputAction::Particle

Definition at line 161 of file Geant4InputAction.h.

◆ Particles

typedef std::vector<Particle*> dd4hep::sim::Geant4InputAction::Particles

Definition at line 162 of file Geant4InputAction.h.

◆ PropertyMask

using dd4hep::sim::Geant4InputAction::PropertyMask = dd4hep::detail::ReferenceBitMask<int>

Definition at line 195 of file Geant4InputAction.h.

◆ Vertex

typedef Geant4Vertex dd4hep::sim::Geant4InputAction::Vertex

Definition at line 160 of file Geant4InputAction.h.

◆ Vertices

typedef std::vector<Vertex*> dd4hep::sim::Geant4InputAction::Vertices

Definition at line 163 of file Geant4InputAction.h.

Constructor & Destructor Documentation

◆ Geant4InputAction()

dd4hep::sim::Geant4InputAction::Geant4InputAction	(	Geant4Context *	context,
		const std::string &	name
	)

Standard constructor.

◆ ~Geant4InputAction()

virtual dd4hep::sim::Geant4InputAction::~Geant4InputAction ( )

virtual

Default destructor.

Member Function Documentation

◆ beginRun()

void dd4hep::sim::Geant4InputAction::beginRun ( const G4Run * )

protected

Perform some actions before the run starts, like opening the event inputs.

◆ createReader()

void dd4hep::sim::Geant4InputAction::createReader ( )

protected

Create the input reader.

◆ issue()

std::string dd4hep::sim::Geant4InputAction::issue ( int i ) const

helper to report Geant4 exceptions

◆ new_particles()

Particles* dd4hep::sim::Geant4InputAction::new_particles ( ) const

inline

Create particle vector.

Definition at line 207 of file Geant4InputAction.h.

◆ operator()()

virtual void dd4hep::sim::Geant4InputAction::operator() ( G4Event * event )

overridevirtual

Callback to generate primary particles.

Reimplemented from dd4hep::sim::Geant4GeneratorAction.

◆ readParticles()

int dd4hep::sim::Geant4InputAction::readParticles	(	int	event_number,
		Vertices &	vertices,
		Particles &	particles
	)

Read an event and return a LCCollectionVec of MCParticles.

◆ setGeneratorStatus()

void dd4hep::sim::Geant4InputAction::setGeneratorStatus	(	int	generatorStatus,
		PropertyMask &	status
	)

Convert the generator status into a common set of generator status bits.

Member Data Documentation

◆ m_abort

bool dd4hep::sim::Geant4InputAction::m_abort

protected

Flag to call abortEvent in case of failure (default: true)

Definition at line 178 of file Geant4InputAction.h.

◆ m_alternativeDecayStatuses

std::set<int> dd4hep::sim::Geant4InputAction::m_alternativeDecayStatuses = {}

protected

Property: set of alternative decay statuses that MC generators might use for unstable particles.

Definition at line 183 of file Geant4InputAction.h.

◆ m_currentEventNumber

int dd4hep::sim::Geant4InputAction::m_currentEventNumber

protected

current event number without initially skipped events

Definition at line 176 of file Geant4InputAction.h.

◆ m_firstEvent

int dd4hep::sim::Geant4InputAction::m_firstEvent

protected

Property: SYNCEVT.

Definition at line 168 of file Geant4InputAction.h.

◆ m_input

std::string dd4hep::sim::Geant4InputAction::m_input

protected

Property: input file.

Definition at line 166 of file Geant4InputAction.h.

◆ m_mask

int dd4hep::sim::Geant4InputAction::m_mask

protected

Property; interaction mask.

Definition at line 170 of file Geant4InputAction.h.

◆ m_momScale

double dd4hep::sim::Geant4InputAction::m_momScale

protected

Property: Momentum downscaler for debugging.

Definition at line 172 of file Geant4InputAction.h.

◆ m_parameters

std::map< std::string, std::string> dd4hep::sim::Geant4InputAction::m_parameters

protected

Property: named parameters to configure file readers or input actions.

Definition at line 180 of file Geant4InputAction.h.

◆ m_reader

Geant4EventReader* dd4hep::sim::Geant4InputAction::m_reader

protected

Event reader object.

Definition at line 174 of file Geant4InputAction.h.

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

DDG4/include/DDG4/Geant4InputAction.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Particle

◆ Particles

◆ PropertyMask

◆ Vertex

◆ Vertices

Constructor & Destructor Documentation

◆ Geant4InputAction()

◆ ~Geant4InputAction()

Member Function Documentation

◆ beginRun()

◆ createReader()

◆ issue()

◆ new_particles()

◆ operator()()

◆ readParticles()

◆ setGeneratorStatus()

Member Data Documentation

◆ m_abort

◆ m_alternativeDecayStatuses

◆ m_currentEventNumber

◆ m_firstEvent

◆ m_input

◆ m_mask

◆ m_momScale

◆ m_parameters

◆ m_reader