Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Protected Member Functions | List of all members
genbb::base_decay_driver Class Referenceabstract

Base decay driver. More...

#include <bayeux/genbb_help/base_decay_driver.h>

Inheritance diagram for genbb::base_decay_driver:
datatools::i_tree_dumpable genbb::alpha_decay genbb::beta_decay genbb::nuclear_transition

Public Member Functions

 base_decay_driver ()
 Default constructor. More...
 
virtual ~base_decay_driver ()
 Destructor. More...
 
datatools::logger::priority get_logging () const
 Return the logging priority threshold. More...
 
void set_logging (datatools::logger::priority)
 Set the logging priority threshold. 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...
 
bool is_initialized () const
 Check initialization status. More...
 
void initialize_simple ()
 Initialization. More...
 
virtual void set_levels (const nuclear_level &level_initial_, const nuclear_level &level_final_)
 Set the transition parameters from the initial and stop levels. More...
 
virtual void initialize (const datatools::properties &setup_)=0
 Initialize from configuration properties. More...
 
virtual void reset ()=0
 Reset. More...
 
virtual int fill (mygsl::rng &prng_, primary_event &event_)=0
 Shoot the kinematics of the decay and fill a primary event. 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

void _set_default ()
 Set the default attributes. More...
 
void _set_initialized (bool)
 Set the initialization flag. More...
 
void _initialize (const datatools::properties &setup_)
 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...
 
- 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_)
 

Detailed Description

Base decay driver.

Constructor & Destructor Documentation

◆ base_decay_driver()

genbb::base_decay_driver::base_decay_driver ( )

Default constructor.

◆ ~base_decay_driver()

virtual genbb::base_decay_driver::~base_decay_driver ( )
virtual

Destructor.

Member Function Documentation

◆ _initialize()

void genbb::base_decay_driver::_initialize ( const datatools::properties setup_)
protected

Initialization.

◆ _set_default()

void genbb::base_decay_driver::_set_default ( )
protected

Set the default attributes.

◆ _set_initialized()

void genbb::base_decay_driver::_set_initialized ( bool  )
protected

Set the initialization flag.

◆ fill()

virtual int genbb::base_decay_driver::fill ( mygsl::rng prng_,
primary_event event_ 
)
pure virtual

Shoot the kinematics of the decay and fill a primary event.

Implemented in genbb::beta_decay, genbb::nuclear_transition, and genbb::alpha_decay.

◆ get_logging()

datatools::logger::priority genbb::base_decay_driver::get_logging ( ) const

Return the logging priority threshold.

◆ initialize()

virtual void genbb::base_decay_driver::initialize ( const datatools::properties setup_)
pure virtual

Initialize from configuration properties.

Implemented in genbb::beta_decay, genbb::nuclear_transition, and genbb::alpha_decay.

◆ initialize_simple()

void genbb::base_decay_driver::initialize_simple ( )

Initialization.

◆ is_initialized()

bool genbb::base_decay_driver::is_initialized ( ) const

Check initialization status.

◆ reset()

virtual void genbb::base_decay_driver::reset ( )
pure virtual

◆ set_levels()

virtual void genbb::base_decay_driver::set_levels ( const nuclear_level level_initial_,
const nuclear_level level_final_ 
)
virtual

Set the transition parameters from the initial and stop levels.

Reimplemented in genbb::beta_decay, genbb::nuclear_transition, and genbb::alpha_decay.

◆ set_logging()

void genbb::base_decay_driver::set_logging ( datatools::logger::priority  )

Set the logging priority threshold.

◆ tree_dump()

virtual void genbb::base_decay_driver::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::beta_decay, genbb::nuclear_transition, and genbb::alpha_decay.


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