The Geant4 simulation module based on Bayeux/dpp API. More...

#include <bayeux/mctools/g4/simulation_module.h>

Inheritance diagram for mctools::g4::simulation_module:

Public Member Functions
	simulation_module (datatools::logger::priority logging_priority=datatools::logger::PRIO_FATAL)
	Constructor. More...

virtual	~simulation_module ()
	Destructor. More...

virtual void	initialize (const datatools::properties &, datatools::service_manager &, dpp::module_handle_dict_type &)
	Initialization. More...

virtual void	reset ()
	Reset. More...

virtual dpp::base_module::process_status	process (datatools::things &)
	Read/Process/Fill/Delete data. More...

void	set_geo_label (const std::string &)
	Set the geometry service label (only used if no geometry manager is provided) More...

const std::string &	get_geo_label () const
	Get the geometry service label (only used if no geometry manager is provided) More...

void	set_sd_label (const std::string &)
	Set the SD bank label. More...

const std::string &	get_sd_label () const
	Get the SD bank label. More...

void	set_geometry_manager (const geomtools::manager &gm)
	Set the reference to an external geometry manager. More...

void	set_geant4_parameters (const manager_parameters &params)
	Set the simulation manager parameters. More...

const manager_parameters &	get_geant4_parameters () const
	Return a non mutable reference to the simulation manager parameters. More...

const mygsl::seed_manager &	get_seed_manager () const
	Return a reference to the embedded seed manager. More...

const mygsl::prng_state_manager &	get_state_manager () const
	Return a non mutable reference to the manager of PRNG's states. More...

Public Member Functions inherited from dpp::base_module
	base_module (datatools::logger::priority p_=datatools::logger::PRIO_FATAL)
	Default constructor : More...

virtual	~base_module ()
	Destructor : More...

bool	has_name () const
	Check the module name. More...

void	set_name (const std::string &)
	Set the module name. More...

const std::string &	get_name () const
	Return the module name. More...

bool	has_description () const
	Check the module description. More...

const std::string &	get_description () const
	Return the module description. More...

void	set_description (const std::string &description_)
	Set the module description. More...

bool	has_last_error_message () const
	Check the module last error message. More...

void	set_last_error_message (const std::string &)
	Set the module last error message. More...

void	append_last_error_message (const std::string &errmsg_)
	Append an error message. More...

void	reset_last_error_message ()
	Reset the module last error message. More...

const std::string &	get_last_error_message () const
	Return the module last error message. More...

bool	is_initialized () const
	Check initialization flag. More...

virtual void	initialize_simple ()
	Initialize the module without external resource. More...

virtual void	initialize_simple_with_service (datatools::service_manager &service_manager_)
	Initialize the module with a service manager only. More...

virtual void	initialize_standalone (const datatools::properties &config_)
	Initialize the module only using a set of parameters. More...

virtual void	initialize_with_service (const datatools::properties &config_, datatools::service_manager &service_manager_)
	Initialize the module using a set of parameters and a service manager. More...

virtual void	initialize_without_service (const datatools::properties &config, module_handle_dict_type &module_dictionnary_)
	Initialize the module using a set of parameters and a map of modules. More...

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Smart print. More...

void	print (std::ostream &out_=std::clog) const
	Default print. More...

void	set_logging_priority (datatools::logger::priority p_)
	Set logging priority. More...

datatools::logger::priority	get_logging_priority () const
	Returns logging priority. More...

Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...

virtual	~i_tree_dumpable ()
	Destructor. More...

virtual void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const
	Main new interface method for printing. More...

void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...

void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...

void	tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const

void	tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const

void	smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const

Protected Member Functions
void	_initialize_manager (datatools::service_manager &)

void	_terminate_manager ()

int	_simulate_event (datatools::things &)

Protected Member Functions inherited from dpp::base_module
void	_set_name (const std::string &name_)
	Set the name of the module. More...

void	_set_initialized (bool initialized_)
	Set the initialization flag of the module. More...

void	_common_initialize (const datatools::properties &config_)
	Basic initialization shared by all inherited modules. More...

Additional Inherited Members
Public Types inherited from dpp::base_module
enum	process_status { PROCESS_OK = 0, PROCESS_SUCCESS = PROCESS_OK, PROCESS_CONTINUE = PROCESS_OK, PROCESS_ERROR = datatools::bit_mask::bit00, PROCESS_FAILURE = PROCESS_ERROR, PROCESS_STOP = datatools::bit_mask::bit01, PROCESS_ERROR_STOP = PROCESS_ERROR \| PROCESS_STOP, PROCESS_FATAL = datatools::bit_mask::bit02, PROCESS_INVALID = datatools::bit_mask::bit31 }
	Processing status flags used as the returned value of data processing methods through the pipeline. More...

Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...

Static Public Member Functions inherited from dpp::base_module
static void	common_ocd (datatools::object_configuration_description &ocd_)
	Basic OCD support shared by all inherited modules. More...

Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree &	empty_options ()

static boost::property_tree::ptree	make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)

static std::ostream &	last_skip_tag (std::ostream &out_)

static std::ostream &	skip_tag (std::ostream &out_)

static std::ostream &	last_tag (std::ostream &out_)

static std::ostream &	tag (std::ostream &out_)

Protected Attributes inherited from dpp::base_module
std::string	_name
	The name of the module. More...

std::string	_description
	The description of the module. More...

datatools::logger::priority	_logging
	The logging priority threshold. More...

bool	_initialized
	The initialization flag. More...

std::string	_last_error_message
	Last error message (questionable) More...

Detailed Description

The Geant4 simulation module based on Bayeux/dpp API.

Constructor & Destructor Documentation

◆ simulation_module()

mctools::g4::simulation_module::simulation_module ( datatools::logger::priority logging_priority = datatools::logger::PRIO_FATAL )

Constructor.

◆ ~simulation_module()

virtual mctools::g4::simulation_module::~simulation_module ( )

virtual

Destructor.

Member Function Documentation

◆ _initialize_manager()

void mctools::g4::simulation_module::_initialize_manager ( datatools::service_manager & )

protected

◆ _simulate_event()

int mctools::g4::simulation_module::_simulate_event ( datatools::things & )

protected

◆ _terminate_manager()

void mctools::g4::simulation_module::_terminate_manager ( )

protected

◆ get_geant4_parameters()

const manager_parameters& mctools::g4::simulation_module::get_geant4_parameters ( ) const

Return a non mutable reference to the simulation manager parameters.

◆ get_geo_label()

const std::string& mctools::g4::simulation_module::get_geo_label ( ) const

Get the geometry service label (only used if no geometry manager is provided)

◆ get_sd_label()

const std::string& mctools::g4::simulation_module::get_sd_label ( ) const

Get the SD bank label.

◆ get_seed_manager()

const mygsl::seed_manager& mctools::g4::simulation_module::get_seed_manager ( ) const

Return a reference to the embedded seed manager.

◆ get_state_manager()

const mygsl::prng_state_manager& mctools::g4::simulation_module::get_state_manager ( ) const

Return a non mutable reference to the manager of PRNG's states.

◆ initialize()

virtual void mctools::g4::simulation_module::initialize	(	const datatools::properties &	,
		datatools::service_manager &	,
		dpp::module_handle_dict_type &
	)

virtual

Initialization.

Implements dpp::base_module.

◆ process()

virtual dpp::base_module::process_status mctools::g4::simulation_module::process ( datatools::things & )

virtual

Read/Process/Fill/Delete data.

Implements dpp::base_module.

◆ reset()

virtual void mctools::g4::simulation_module::reset ( )

virtual

Reset.

Implements dpp::base_module.

◆ set_geant4_parameters()

void mctools::g4::simulation_module::set_geant4_parameters ( const manager_parameters & params )

Set the simulation manager parameters.

◆ set_geo_label()

void mctools::g4::simulation_module::set_geo_label ( const std::string & )

Set the geometry service label (only used if no geometry manager is provided)

◆ set_geometry_manager()

void mctools::g4::simulation_module::set_geometry_manager ( const geomtools::manager & gm )

Set the reference to an external geometry manager.

◆ set_sd_label()

void mctools::g4::simulation_module::set_sd_label ( const std::string & )

Set the SD bank label.

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

bayeux/mctools/g4/simulation_module.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ simulation_module()

◆ ~simulation_module()

Member Function Documentation

◆ _initialize_manager()

◆ _simulate_event()

◆ _terminate_manager()

◆ get_geant4_parameters()

◆ get_geo_label()

◆ get_sd_label()

◆ get_seed_manager()

◆ get_state_manager()

◆ initialize()

◆ process()

◆ reset()

◆ set_geant4_parameters()

◆ set_geo_label()

◆ set_geometry_manager()

◆ set_sd_label()