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

Decay0/GENBB (C++ port) generator wrapper. More...

#include <bayeux/genbb_help/wdecay0.h>

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

Public Types

enum  decay_type { DECAY_TYPE_UNDEFINED = 0, DECAY_TYPE_DBD = 1, DECAY_TYPE_BACKGROUND = 2 }
 Type of decay. 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

virtual bool can_external_random () const
 Check if the generator accepts an external PRNG. More...
 
const mygsl::rngget_random () const
 
mygsl::rnggrab_random ()
 
size_t get_event_count () const
 
double get_to_all_events () const
 
 wdecay0 ()
 
virtual ~wdecay0 ()
 
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 dump (std::ostream &=std::clog) const
 
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 method. More...
 
virtual bool has_next ()
 Returns true if the generator can provide one more generated event. More...
 
virtual bool is_initialized () const
 Check initialization status. More...
 
genbb::decay0::bbparsbb_params ()
 
- 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::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...
 
- 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 Attributes

static const int DBD_MODE_INVALID = -1
 Invalid decay mode. More...
 

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

- 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

Decay0/GENBB (C++ port) generator wrapper.

Member Enumeration Documentation

◆ decay_type

Type of decay.

Enumerator
DECAY_TYPE_UNDEFINED 

Undefined decay type.

DECAY_TYPE_DBD 

Double beta decay.

DECAY_TYPE_BACKGROUND 

Radioactive background decay.

Constructor & Destructor Documentation

◆ wdecay0()

genbb::wdecay0::wdecay0 ( )

◆ ~wdecay0()

virtual genbb::wdecay0::~wdecay0 ( )
virtual

Member Function Documentation

◆ _load_next()

virtual void genbb::wdecay0::_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.

◆ bb_params()

genbb::decay0::bbpars& genbb::wdecay0::bb_params ( )

◆ can_external_random()

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

Check if the generator accepts an external PRNG.

Reimplemented from genbb::i_genbb.

◆ dump()

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

◆ get_event_count()

size_t genbb::wdecay0::get_event_count ( ) const

◆ get_random()

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

◆ get_to_all_events()

double genbb::wdecay0::get_to_all_events ( ) const

◆ grab_random()

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

◆ has_next()

virtual bool genbb::wdecay0::has_next ( )
virtual

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

Implements genbb::i_genbb.

◆ initialize()

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

Check initialization status.

Implements genbb::i_genbb.

◆ reset()

virtual void genbb::wdecay0::reset ( )
virtual

Reset method.

Implements genbb::i_genbb.

◆ tree_dump()

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

Smart print.

Reimplemented from genbb::i_genbb.

Member Data Documentation

◆ DBD_MODE_INVALID

const int genbb::wdecay0::DBD_MODE_INVALID = -1
static

Invalid decay mode.


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