GENBB particle generator abstract base class. More...

#include <bayeux/genbb_help/i_genbb.h>

Inheritance diagram for genbb::i_genbb:

Public Member Functions
bool	has_name () const
	Check for a non-empty name. More...

const std::string &	get_name () const
	Return the name of the event generator. More...

void	set_name (const std::string &)
	Set the name of the event generator. More...

void	reset_name ()
	Reset the name of the event generator. More...

	i_genbb ()
	Constructor. More...

virtual	~i_genbb ()
	Destructor. More...

virtual void	load_next (primary_event &event_, bool compute_classification_=true)
	Load a new 'primary_event' object. More...

virtual bool	can_external_random () const
	Check if the generator accepts an external PRNG. More...

virtual bool	has_external_random () const
	Check if the generator uses an external PRNG. More...

virtual void	set_external_random (mygsl::rng &)
	Set an external PRNG. More...

virtual void	reset_external_random ()
	Reset an external PRNG. More...

mygsl::rng &	grab_external_random ()
	Return a mutable reference to the external PRNG. More...

const mygsl::rng &	get_external_random () const
	Return a non-mutable reference to the external PRNG. More...

virtual void	initialize_simple ()
	Simple initialization (no external resource) More...

virtual void	initialize_standalone (const datatools::properties &setup_)
	Initialization from a container of properties. More...

virtual void	initialize_with_service_only (const datatools::properties &setup_, datatools::service_manager &service_manager_)
	Initialization from a container of properties and a service manager. More...

virtual void	initialize_with_dictionary_only (const datatools::properties &setup_, detail::pg_dict_type &dictionary_)
	Initialization from a container of properties, a service manager and a dictionnary of vertex generators. More...

virtual bool	is_initialized () const =0
	Check initialization status. More...

virtual void	initialize (const datatools::properties &setup_, datatools::service_manager &service_manager_, detail::pg_dict_type &dictionary_)=0
	Main initialization interface method. More...

virtual void	reset ()=0
	Reset method. More...

virtual bool	has_next ()=0
	Returns true if the generator can provide one more generated event. More...

datatools::logger::priority	get_logging_priority () const
	Return the logging priority threshold. More...

void	set_logging_priority (datatools::logger::priority p)
	Set the logging priority threshold. More...

bool	is_debug () const
	Check the debug logging. More...

void	set_assign_generation_ids (bool)
	Set the flag to assign unique generation Ids to primary particles. More...

bool	is_assign_generation_ids () const
	Check the flag to assign unique generation Ids to primary particles. 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...

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

Static Public Member Functions
static void	base_initialize_ocd (datatools::object_configuration_description &)
	OCD interface. 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 Member Functions
virtual void	_load_next (primary_event &event_, bool compute_classification_)=0
	Protected abstract interface to be invoked by the public 'load_next' method. More...

void	_initialize_base (const datatools::properties &setup_)
	Base initialization. More...

Protected Attributes
datatools::logger::priority	_logging_priority

Additional Inherited Members
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...

Detailed Description

GENBB particle generator abstract base class.

Constructor & Destructor Documentation

◆ i_genbb()

genbb::i_genbb::i_genbb ( )

Constructor.

◆ ~i_genbb()

virtual genbb::i_genbb::~i_genbb ( )

virtual

Destructor.

Member Function Documentation

◆ _initialize_base()

void genbb::i_genbb::_initialize_base ( const datatools::properties & setup_ )

protected

Base initialization.

◆ _load_next()

virtual void genbb::i_genbb::_load_next	(	primary_event &	event_,
		bool	compute_classification_
	)

protectedpure virtual

Protected abstract interface to be invoked by the public 'load_next' method.

Implemented in genbb::single_particle_generator, genbb::combined_particle_generator, genbb::lorentz_boost_wrapper, genbb::time_slicer_generator, genbb::wdecay0, genbb::genbb_mgr, genbb::nuclear_decay_generator, genbb::save_to_file_wrapper, and genbb::from_file_generator.

◆ base_initialize_ocd()

static void genbb::i_genbb::base_initialize_ocd ( datatools::object_configuration_description & )

static

OCD interface.

◆ can_external_random()

virtual bool genbb::i_genbb::can_external_random ( ) const

virtual

Check if the generator accepts an external PRNG.

Reimplemented in genbb::single_particle_generator, genbb::time_slicer_generator, genbb::combined_particle_generator, genbb::nuclear_decay_generator, and genbb::wdecay0.

◆ get_external_random()

const mygsl::rng& genbb::i_genbb::get_external_random ( ) const

Return a non-mutable reference to the external PRNG.

◆ get_logging_priority()

datatools::logger::priority genbb::i_genbb::get_logging_priority ( ) const

Return the logging priority threshold.

◆ get_name()

const std::string& genbb::i_genbb::get_name ( ) const

Return the name of the event generator.

◆ grab_external_random()

mygsl::rng& genbb::i_genbb::grab_external_random ( )

Return a mutable reference to the external PRNG.

◆ has_external_random()

virtual bool genbb::i_genbb::has_external_random ( ) const

virtual

Check if the generator uses an external PRNG.

◆ has_name()

bool genbb::i_genbb::has_name ( ) const

Check for a non-empty name.

◆ has_next()

virtual bool genbb::i_genbb::has_next ( )

pure virtual

Returns true if the generator can provide one more generated event.

Implemented in genbb::single_particle_generator, genbb::lorentz_boost_wrapper, genbb::combined_particle_generator, genbb::time_slicer_generator, genbb::genbb_mgr, genbb::wdecay0, genbb::save_to_file_wrapper, genbb::nuclear_decay_generator, and genbb::from_file_generator.

◆ initialize()

virtual void genbb::i_genbb::initialize	(	const datatools::properties &	setup_,
		datatools::service_manager &	service_manager_,
		detail::pg_dict_type &	dictionary_
	)

pure virtual

Main initialization interface method.

Implemented in genbb::single_particle_generator, genbb::lorentz_boost_wrapper, genbb::combined_particle_generator, genbb::time_slicer_generator, genbb::genbb_mgr, genbb::wdecay0, genbb::save_to_file_wrapper, genbb::nuclear_decay_generator, and genbb::from_file_generator.

◆ initialize_simple()

virtual void genbb::i_genbb::initialize_simple ( )

virtual

Simple initialization (no external resource)

◆ initialize_standalone()

virtual void genbb::i_genbb::initialize_standalone ( const datatools::properties & setup_ )

virtual

Initialization from a container of properties.

◆ initialize_with_dictionary_only()

virtual void genbb::i_genbb::initialize_with_dictionary_only	(	const datatools::properties &	setup_,
		detail::pg_dict_type &	dictionary_
	)

virtual

Initialization from a container of properties, a service manager and a dictionnary of vertex generators.

◆ initialize_with_service_only()

virtual void genbb::i_genbb::initialize_with_service_only	(	const datatools::properties &	setup_,
		datatools::service_manager &	service_manager_
	)

virtual

Initialization from a container of properties and a service manager.

◆ is_assign_generation_ids()

bool genbb::i_genbb::is_assign_generation_ids ( ) const

Check the flag to assign unique generation Ids to primary particles.

◆ is_debug()

bool genbb::i_genbb::is_debug ( ) const

Check the debug logging.

◆ is_initialized()

virtual bool genbb::i_genbb::is_initialized ( ) const

pure virtual

Check initialization status.

Implemented in genbb::single_particle_generator, genbb::lorentz_boost_wrapper, genbb::combined_particle_generator, genbb::time_slicer_generator, genbb::wdecay0, genbb::genbb_mgr, genbb::save_to_file_wrapper, genbb::nuclear_decay_generator, and genbb::from_file_generator.

◆ load_next()

virtual void genbb::i_genbb::load_next	(	primary_event &	event_,
		bool	compute_classification_ = `true`
	)

virtual

Load a new 'primary_event' object.

◆ reset()

virtual void genbb::i_genbb::reset ( )

pure virtual

Reset method.

Implemented in genbb::single_particle_generator, genbb::lorentz_boost_wrapper, genbb::combined_particle_generator, genbb::time_slicer_generator, genbb::genbb_mgr, genbb::wdecay0, genbb::save_to_file_wrapper, genbb::nuclear_decay_generator, and genbb::from_file_generator.

◆ reset_external_random()

virtual void genbb::i_genbb::reset_external_random ( )

virtual

Reset an external PRNG.

◆ reset_name()

void genbb::i_genbb::reset_name ( )

Reset the name of the event generator.

◆ set_assign_generation_ids()

void genbb::i_genbb::set_assign_generation_ids ( bool )

Set the flag to assign unique generation Ids to primary particles.

◆ set_external_random()

virtual void genbb::i_genbb::set_external_random ( mygsl::rng & )

virtual

Set an external PRNG.

◆ set_logging_priority()

void genbb::i_genbb::set_logging_priority ( datatools::logger::priority p )

Set the logging priority threshold.

◆ set_name()

void genbb::i_genbb::set_name ( const std::string & )

Set the name of the event generator.

◆ tree_dump()

virtual void genbb::i_genbb::tree_dump	(	std::ostream &	out = `std::clog`,
		const std::string &	title = `""`,
		const std::string &	indent = `""`,
		bool	inherit = `false`
	)		const

virtual

Smart print.

Reimplemented from datatools::i_tree_dumpable.

Reimplemented in genbb::wdecay0.

Member Data Documentation

◆ _logging_priority

datatools::logger::priority genbb::i_genbb::_logging_priority

protected

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

bayeux/genbb_help/i_genbb.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ i_genbb()

◆ ~i_genbb()

Member Function Documentation

◆ _initialize_base()

◆ _load_next()

◆ base_initialize_ocd()

◆ can_external_random()

◆ get_external_random()

◆ get_logging_priority()

◆ get_name()

◆ grab_external_random()

◆ has_external_random()

◆ has_name()

◆ has_next()

◆ initialize()

◆ initialize_simple()

◆ initialize_standalone()

◆ initialize_with_dictionary_only()

◆ initialize_with_service_only()

◆ is_assign_generation_ids()

◆ is_debug()

◆ is_initialized()

◆ load_next()

◆ reset()

◆ reset_external_random()

◆ reset_name()

◆ set_assign_generation_ids()

◆ set_external_random()

◆ set_logging_priority()

◆ set_name()

◆ tree_dump()

Member Data Documentation

◆ _logging_priority