Generator for combined generators. More...

#include <bayeux/genbb_help/combined_particle_generator.h>

Inheritance diagram for genbb::combined_particle_generator:

Classes
struct	entry_type
	Particle generator entry. More...

Public Types
enum	time_delay_type { TIME_DELAY_UNDEFINED = 0, TIME_DELAY_FIXED = 1, TIME_DELAY_DECAY = 2, TIME_DELAY_RANGE = 3, TIME_DELAY_GAUSSIAN = 4, TIME_DELAY_DEFAULT = TIME_DELAY_FIXED }
	Time delay mode. More...

enum	mode_type { MODE_UNDEFINED = 0, MODE_PLAIN_PROBABILITY = 1, MODE_ACTIVITY = 2, MODE_TIME = 3 }
	Generation mode. More...

typedef std::vector< entry_type >	pg_col_type
	Collection of particle generator entry type. 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...

Public Member Functions
void	set_mode (int mode_)
	Set the generation mode. More...

bool	is_mode_time () const
	Check if generation mode is based on time generation. More...

bool	is_mode_plain_probability () const
	Check if generation mode is based on plain probability. More...

bool	is_mode_activity () const
	Check if generation mode is based on activity. More...

virtual bool	can_external_random () const
	Check existence of external random. More...

const mygsl::rng &	get_random () const
	Return a non-mutable random generator. More...

mygsl::rng &	grab_random ()
	Return a mutable random generator. More...

	combined_particle_generator ()
	Constructor. More...

virtual	~combined_particle_generator ()
	Destructor. More...

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

virtual void	reset ()
	Reset. More...

virtual bool	has_next ()
	Check next generation event. More...

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

void	dump (std::ostream &out_, const std::string &title_, const std::string &indent_="") const
	Smart dump. More...

Public Member Functions inherited from genbb::i_genbb
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	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...

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

Protected Member Functions
virtual void	_load_next (primary_event &event_, bool compute_classification_=true)
	Main generation function. More...

Protected Member Functions inherited from genbb::i_genbb
void	_initialize_base (const datatools::properties &setup_)
	Base initialization. More...

Additional Inherited Members
Static Public Member Functions inherited from genbb::i_genbb
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 Attributes inherited from genbb::i_genbb
datatools::logger::priority	_logging_priority

Detailed Description

Generator for combined generators.

Member Typedef Documentation

◆ pg_col_type

typedef std::vector<entry_type> genbb::combined_particle_generator::pg_col_type

Collection of particle generator entry type.

Member Enumeration Documentation

◆ mode_type

enum genbb::combined_particle_generator::mode_type

Generation mode.

Enumerator
MODE_UNDEFINED	Undefined mode.
MODE_PLAIN_PROBABILITY	Branching ratios given by probability.
MODE_ACTIVITY	Branching ratios given by absolute activity.
MODE_TIME	Cascade of events from a time sequence.

◆ time_delay_type

enum genbb::combined_particle_generator::time_delay_type

Time delay mode.

Enumerator
TIME_DELAY_UNDEFINED	Undefined time delay mode.
TIME_DELAY_FIXED	Fixed time delay.
TIME_DELAY_DECAY	Random exponential time delay.
TIME_DELAY_RANGE	Random ranged time delay.
TIME_DELAY_GAUSSIAN	Gaussian ranged time delay.
TIME_DELAY_DEFAULT

Constructor & Destructor Documentation

◆ combined_particle_generator()

genbb::combined_particle_generator::combined_particle_generator ( )

Constructor.

◆ ~combined_particle_generator()

virtual genbb::combined_particle_generator::~combined_particle_generator ( )

virtual

Destructor.

Member Function Documentation

◆ _load_next()

virtual void genbb::combined_particle_generator::_load_next	(	primary_event &	event_,
		bool	compute_classification_ = `true`
	)

protectedvirtual

Main generation function.

Implements genbb::i_genbb.

◆ can_external_random()

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

virtual

Check existence of external random.

Reimplemented from genbb::i_genbb.

◆ dump()

void genbb::combined_particle_generator::dump	(	std::ostream &	out_,
		const std::string &	title_,
		const std::string &	indent_ = `""`
	)		const

Smart dump.

◆ get_random()

const mygsl::rng& genbb::combined_particle_generator::get_random ( ) const

Return a non-mutable random generator.

◆ grab_random()

mygsl::rng& genbb::combined_particle_generator::grab_random ( )

Return a mutable random generator.

◆ has_next()

virtual bool genbb::combined_particle_generator::has_next ( )

virtual

Check next generation event.

Implements genbb::i_genbb.

◆ initialize()

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

virtual

Main initialization interface method.

Implements genbb::i_genbb.

◆ is_initialized()

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

virtual

Check initialization status.

Implements genbb::i_genbb.

◆ is_mode_activity()

bool genbb::combined_particle_generator::is_mode_activity ( ) const

Check if generation mode is based on activity.

◆ is_mode_plain_probability()

bool genbb::combined_particle_generator::is_mode_plain_probability ( ) const

Check if generation mode is based on plain probability.

◆ is_mode_time()

bool genbb::combined_particle_generator::is_mode_time ( ) const

Check if generation mode is based on time generation.

◆ reset()

virtual void genbb::combined_particle_generator::reset ( )

virtual

Reset.

Implements genbb::i_genbb.

◆ set_mode()

void genbb::combined_particle_generator::set_mode ( int mode_ )

Set the generation mode.

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

bayeux/genbb_help/combined_particle_generator.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ pg_col_type

Member Enumeration Documentation

◆ mode_type

◆ time_delay_type

Constructor & Destructor Documentation

◆ combined_particle_generator()

◆ ~combined_particle_generator()

Member Function Documentation

◆ _load_next()

◆ can_external_random()

◆ dump()

◆ get_random()

◆ grab_random()

◆ has_next()

◆ initialize()

◆ is_initialized()

◆ is_mode_activity()

◆ is_mode_plain_probability()

◆ is_mode_time()

◆ reset()

◆ set_mode()