Wrapper for another generator. More...

#include <bayeux/genbb_help/save_to_file_wrapper.h>

Inheritance diagram for genbb::save_to_file_wrapper:

Public Member Functions
void	set_primary_event_bank_label (const std::string &)
	Set the label of the primary event bank. More...

void	set_generator (i_genbb &)
	Set the particle generator. More...

	save_to_file_wrapper ()
	Default constructor. More...

virtual	~save_to_file_wrapper ()
	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 if the generator has a next event. More...

virtual bool	is_initialized () const
	Check initialization status. 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	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...

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 const std::string &	default_pe_label ()
	Return the default label for the "primary event" bank. More...

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 Member Functions
virtual void	_load_next (primary_event &event_, bool compute_classification_=true)
	Load next primary event from the generator algorithm. More...

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

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...

Protected Attributes inherited from genbb::i_genbb
datatools::logger::priority	_logging_priority

Detailed Description

Wrapper for another generator.

Constructor & Destructor Documentation

◆ save_to_file_wrapper()

genbb::save_to_file_wrapper::save_to_file_wrapper ( )

Default constructor.

◆ ~save_to_file_wrapper()

virtual genbb::save_to_file_wrapper::~save_to_file_wrapper ( )

virtual

Destructor.

Member Function Documentation

◆ _load_next()

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

protectedvirtual

Load next primary event from the generator algorithm.

Implements genbb::i_genbb.

◆ default_pe_label()

static const std::string& genbb::save_to_file_wrapper::default_pe_label ( )

static

Return the default label for the "primary event" bank.

◆ has_next()

virtual bool genbb::save_to_file_wrapper::has_next ( )

virtual

Check if the generator has a next event.

Implements genbb::i_genbb.

◆ initialize()

virtual void genbb::save_to_file_wrapper::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::save_to_file_wrapper::is_initialized ( ) const

virtual

Check initialization status.

Implements genbb::i_genbb.

◆ reset()

virtual void genbb::save_to_file_wrapper::reset ( )

virtual

Reset.

Implements genbb::i_genbb.

◆ set_generator()

void genbb::save_to_file_wrapper::set_generator ( i_genbb & )

Set the particle generator.

◆ set_primary_event_bank_label()

void genbb::save_to_file_wrapper::set_primary_event_bank_label ( const std::string & )

Set the label of the primary event bank.

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

bayeux/genbb_help/save_to_file_wrapper.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ save_to_file_wrapper()

◆ ~save_to_file_wrapper()

Member Function Documentation

◆ _load_next()

◆ default_pe_label()

◆ has_next()

◆ initialize()

◆ is_initialized()

◆ reset()

◆ set_generator()

◆ set_primary_event_bank_label()