Description of a nuclear decay. More...

#include <bayeux/genbb_help/nuclear_decay.h>

Inheritance diagram for genbb::nuclear_decay:

Public Types
typedef datatools::handle< nuclear_decay >	handle_type
	Handle 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
	nuclear_decay ()
	Default constructor. More...

virtual	~nuclear_decay ()
	Destructor. More...

bool	is_valid () const
	Check validity. More...

bool	check_decay (std::string &) const
	Check if the decay mode is compatible with parent and daughter levels. More...

bool	has_decay_id () const
	Check if the decay identifier is set. More...

const std::string &	get_decay_id () const
	Return the decay identifier. More...

void	set_decay_id (const std::string &)
	Set the decay identifier. More...

void	set_level_initial (const nuclear_level &)
	Set the parent level. More...

const nuclear_level &	get_level_initial () const
	Return the parent level. More...

void	set_level_final (const nuclear_level &)
	Set the daughter level. More...

const nuclear_level &	get_level_final () const
	Return the daughter level. More...

const datatools::properties &	get_auxiliaries () const
	Return auxiliary properties. More...

datatools::properties &	grab_auxiliaries ()
	Return auxiliary properties. More...

bool	is_initialized () const
	Check initialization flag. More...

void	initialize (const datatools::properties &config_, const std::map< std::string, datatools::handle< nuclear_level > > *levels_=0)
	Initialize from a list of parameters and a dictionary of nuclear levels. More...

void	initialize_simple ()
	Standalone initialization. More...

void	reset ()
	Reset. More...

std::string	to_string (unsigned int=0) const
	Return a descriptive string. 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	has_decay_driver () const
	Check the decay driver avaibility. More...

base_decay_driver &	grab_decay_driver ()
	Return the decay driver. 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...

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	_init_decay_driver (const datatools::properties &)
	Initialization of the embedded decay driver. More...

void	_set_default ()
	Set attributes' default values. More...

Additional Inherited Members
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

Description of a nuclear decay.

Member Typedef Documentation

◆ handle_type

typedef datatools::handle<nuclear_decay> genbb::nuclear_decay::handle_type

Handle type.

Constructor & Destructor Documentation

◆ nuclear_decay()

genbb::nuclear_decay::nuclear_decay ( )

Default constructor.

◆ ~nuclear_decay()

virtual genbb::nuclear_decay::~nuclear_decay ( )

virtual

Destructor.

Member Function Documentation

◆ _init_decay_driver()

void genbb::nuclear_decay::_init_decay_driver ( const datatools::properties & )

protected

Initialization of the embedded decay driver.

◆ _set_default()

void genbb::nuclear_decay::_set_default ( )

protected

Set attributes' default values.

◆ check_decay()

bool genbb::nuclear_decay::check_decay ( std::string & ) const

Check if the decay mode is compatible with parent and daughter levels.

◆ get_auxiliaries()

const datatools::properties& genbb::nuclear_decay::get_auxiliaries ( ) const

Return auxiliary properties.

◆ get_decay_id()

const std::string& genbb::nuclear_decay::get_decay_id ( ) const

Return the decay identifier.

◆ get_level_final()

const nuclear_level& genbb::nuclear_decay::get_level_final ( ) const

Return the daughter level.

◆ get_level_initial()

const nuclear_level& genbb::nuclear_decay::get_level_initial ( ) const

Return the parent level.

◆ get_logging()

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

Return the logging priority threshold.

◆ grab_auxiliaries()

datatools::properties& genbb::nuclear_decay::grab_auxiliaries ( )

Return auxiliary properties.

◆ grab_decay_driver()

base_decay_driver& genbb::nuclear_decay::grab_decay_driver ( )

Return the decay driver.

◆ has_decay_driver()

bool genbb::nuclear_decay::has_decay_driver ( ) const

Check the decay driver avaibility.

◆ has_decay_id()

bool genbb::nuclear_decay::has_decay_id ( ) const

Check if the decay identifier is set.

◆ initialize()

void genbb::nuclear_decay::initialize	(	const datatools::properties &	config_,
		const std::map< std::string, datatools::handle< nuclear_level > > *	levels_ = `0`
	)

Initialize from a list of parameters and a dictionary of nuclear levels.

◆ initialize_simple()

void genbb::nuclear_decay::initialize_simple ( )

Standalone initialization.

◆ is_initialized()

bool genbb::nuclear_decay::is_initialized ( ) const

Check initialization flag.

◆ is_valid()

bool genbb::nuclear_decay::is_valid ( ) const

Check validity.

◆ reset()

void genbb::nuclear_decay::reset ( )

Reset.

◆ set_decay_id()

void genbb::nuclear_decay::set_decay_id ( const std::string & )

Set the decay identifier.

◆ set_level_final()

void genbb::nuclear_decay::set_level_final ( const nuclear_level & )

Set the daughter level.

◆ set_level_initial()

void genbb::nuclear_decay::set_level_initial ( const nuclear_level & )

Set the parent level.

◆ set_logging()

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

Set the logging priority threshold.

◆ to_string()

std::string genbb::nuclear_decay::to_string ( unsigned int = 0 ) const

Return a descriptive string.

◆ tree_dump()

virtual void genbb::nuclear_decay::tree_dump	(	std::ostream &	out_ = `std::clog`,
		const std::string &	title_ = `""`,
		const std::string &	indent_ = `""`,
		bool	inherit_ = `false`
	)		const