Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
genbb::genbb_mgr Class Reference

Legacy bridge manager that reads Genbb files. More...

#include <bayeux/genbb_help/genbb_mgr.h>

Inheritance diagram for genbb::genbb_mgr:
genbb::i_genbb datatools::i_tree_dumpable

Public Types

enum  format_type { FORMAT_GENBB = 0, FORMAT_BOOST = 1 }
 
- 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

bool is_debug () const
 
void set_debug (bool d_)
 
int get_format () const
 
void set_format (int format_=FORMAT_GENBB)
 
void set_format (const std::string &format_="")
 
bool is_format_genbb () const
 
bool is_format_boost () const
 
 genbb_mgr (int format_=FORMAT_GENBB)
 Constructor. More...
 
virtual ~genbb_mgr ()
 Destructor. More...
 
void dump (std::ostream &out_=std::clog) const
 
void set (const std::string &filename_)
 
virtual bool is_initialized () const
 Check initialization status. More...
 
virtual void initialize (const datatools::properties &config_, datatools::service_manager &service_manager_, detail::pg_dict_type &dictionary_)
 Main initialization interface method. More...
 
virtual void reset ()
 Reset method. More...
 
virtual bool has_next ()
 Returns true if the generator can provide one more generated event. 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::rnggrab_external_random ()
 Return a mutable reference to the external PRNG. More...
 
const mygsl::rngget_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 & format_genbb_label ()
 
static const std::string & format_boost_label ()
 
- 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)
 Protected abstract interface to be invoked by the public 'load_next' method. More...
 
- Protected Member Functions inherited from genbb::i_genbb
void _initialize_base (const datatools::properties &setup_)
 Base initialization. More...
 

Additional Inherited Members

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

Detailed Description

Legacy bridge manager that reads Genbb files.

Member Enumeration Documentation

◆ format_type

Enumerator
FORMAT_GENBB 
FORMAT_BOOST 

Constructor & Destructor Documentation

◆ genbb_mgr()

genbb::genbb_mgr::genbb_mgr ( int  format_ = FORMAT_GENBB)

Constructor.

◆ ~genbb_mgr()

virtual genbb::genbb_mgr::~genbb_mgr ( )
virtual

Destructor.

Member Function Documentation

◆ _load_next()

virtual void genbb::genbb_mgr::_load_next ( primary_event event_,
bool  compute_classification_ = true 
)
protectedvirtual

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

Implements genbb::i_genbb.

◆ dump()

void genbb::genbb_mgr::dump ( std::ostream &  out_ = std::clog) const

◆ format_boost_label()

static const std::string& genbb::genbb_mgr::format_boost_label ( )
static

◆ format_genbb_label()

static const std::string& genbb::genbb_mgr::format_genbb_label ( )
static

◆ get_format()

int genbb::genbb_mgr::get_format ( ) const

◆ has_next()

virtual bool genbb::genbb_mgr::has_next ( )
virtual

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

Implements genbb::i_genbb.

◆ initialize()

virtual void genbb::genbb_mgr::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_debug()

bool genbb::genbb_mgr::is_debug ( ) const

◆ is_format_boost()

bool genbb::genbb_mgr::is_format_boost ( ) const

◆ is_format_genbb()

bool genbb::genbb_mgr::is_format_genbb ( ) const

◆ is_initialized()

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

Check initialization status.

Implements genbb::i_genbb.

◆ reset()

virtual void genbb::genbb_mgr::reset ( )
virtual

Reset method.

Implements genbb::i_genbb.

◆ set()

void genbb::genbb_mgr::set ( const std::string &  filename_)

◆ set_debug()

void genbb::genbb_mgr::set_debug ( bool  d_)

◆ set_format() [1/2]

void genbb::genbb_mgr::set_format ( int  format_ = FORMAT_GENBB)

◆ set_format() [2/2]

void genbb::genbb_mgr::set_format ( const std::string &  format_ = "")

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