Species Class Reference

#include <Species.h>

Inheritance diagram for Species:

Defines the species interface for the TransitionSystem. More...

Public Types
typedef SP_Species	SP
	strong pointer More...
typedef WP_Species	WP
	weak pointer More...

INTERFACE<<Origen::Checkable>>
See Origen::Checkable for details.
std::string	name () const
void	get_name (std::string &name) const
void	set_name (std::string name)
int	id () const
void	get_id (int &id) const
void	set_id (int id)
bool	has_initialized_id () const
std::string	to_string () const
bool	good () const
bool	good (Vec_Str &errors) const
bool	is_initialized () const
Scale::Json::Value	to_json () const

INTERFACE<<Origen::Species>>
See Origen::Species for details.
int	charge_number () const
void	get_charge_number (int &charge_number) const
void	set_charge_number (int charge_number)
bool	has_initialized_charge_number () const
int	mass_number () const
void	get_mass_number (int &mass_number) const
void	set_mass_number (int mass_number)
bool	has_initialized_mass_number () const
double	mass () const
void	get_mass (double &mass) const
void	set_mass (double mass)
bool	has_initialized_mass () const

Public Member Functions
virtual	~Species ()
	destructor More...

Private Member Functions
virtual int	charge_number_impl () const =0
virtual void	get_charge_number_impl (int &charge_number) const
virtual void	set_charge_number_impl (int charge_number)
virtual bool	has_initialized_charge_number_impl () const
virtual int	mass_number_impl () const =0
virtual void	get_mass_number_impl (int &mass_number) const
virtual void	set_mass_number_impl (int mass_number)
virtual bool	has_initialized_mass_number_impl () const
virtual double	mass_impl () const =0
virtual void	get_mass_impl (double &mass) const
virtual void	set_mass_impl (double mass)
virtual bool	has_initialized_mass_impl () const
virtual bool	is_initialized_impl () const
	useful to chain More...
virtual std::string	name_impl () const
virtual int	id_impl () const
virtual bool	good_impl (Vec_Str &errors) const
	useful to chain More...
virtual Scale::Json::Value	to_json_impl () const
	useful to chain More...

Detailed Description

Defines the species interface for the TransitionSystem.

The species, in the context of the transition system, manages three piece of data:

1. charge number (e)
2. mass number (neutrons+protons)
3. mass (grams/mole)

See also

Nuclide

Member Typedef Documentation

typedef SP_Species SP

strong pointer

typedef WP_Species WP

weak pointer

Constructor & Destructor Documentation

~Species ( )

virtual

destructor

Member Function Documentation

int charge_number

(

)

const

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by Species_Gen::set_charge_number_impl(), and TEST().

void get_charge_number

(

int &

charge_number

)

const

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

void set_charge_number

(

int

charge_number

)

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

bool has_initialized_charge_number

(

)

const

int mass_number

(

)

const

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by Species_Gen::set_mass_number_impl(), and TEST().

void get_mass_number

(

int &

mass_number

)

const

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

void set_mass_number

(

int

mass_number

)

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

bool has_initialized_mass_number

(

)

const

double mass

(

)

const

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by Species_Gen::set_mass_impl(), and TEST().

void get_mass

(

double &

mass

)

const

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

void set_mass

(

double

mass

)

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

bool has_initialized_mass

(

)

const

int charge_number_impl ( ) const

privatepure virtual

Implemented in Null, Neutrino, Positron, Electron, Alpha, Helion, Triton, Species_Gen, Deuteron, Proton, and Neutron.

References Origen::BAD_INT.

void get_charge_number_impl ( int &  charge_number ) const

privatevirtual

Reimplemented in Species_Gen.

void set_charge_number_impl ( int  charge_number )

privatevirtual

Reimplemented in Species_Gen.

bool has_initialized_charge_number_impl ( ) const

privatevirtual

References Origen::BAD_INT.

int mass_number_impl ( ) const

privatepure virtual

Implemented in Null, Neutrino, Positron, Electron, Alpha, Helion, Triton, Species_Gen, Deuteron, Proton, and Neutron.

References Origen::BAD_INT.

void get_mass_number_impl ( int &  mass_number ) const

privatevirtual

Reimplemented in Species_Gen.

void set_mass_number_impl ( int  mass_number )

privatevirtual

Reimplemented in Species_Gen.

bool has_initialized_mass_number_impl ( ) const

privatevirtual

References Origen::BAD_INT.

double mass_impl ( ) const

privatepure virtual

Implemented in Null, Neutrino, Positron, Electron, Alpha, Helion, Triton, Species_Gen, Deuteron, Proton, and Neutron.

References Origen::BAD_DOUBLE.

void get_mass_impl ( double &  mass ) const

privatevirtual

Reimplemented in Species_Gen.

void set_mass_impl ( double  mass )

privatevirtual

Reimplemented in Species_Gen.

bool has_initialized_mass_impl ( ) const

privatevirtual

References Origen::BAD_DOUBLE.

bool is_initialized_impl ( ) const

privatevirtual

useful to chain

Reimplemented from Checkable.

std::string name_impl ( ) const

privatevirtual

Reimplemented from Checkable.

Reimplemented in Null, Neutrino, Positron, Electron, Alpha, Helion, Triton, Deuteron, Proton, and Neutron.

int id_impl ( ) const

privatevirtual

Reimplemented from Checkable.

Reimplemented in Null, Neutrino, Positron, Electron, Alpha, Helion, Triton, Deuteron, Proton, and Neutron.

bool good_impl ( Vec_Str &  errors ) const

privatevirtual

useful to chain

Reimplemented from Checkable.

Reimplemented in Null, Neutrino, Positron, Electron, Alpha, Helion, Triton, Deuteron, Proton, and Neutron.

References ORIGEN_CHECKABLE_ERROR.

Json::Value to_json_impl ( ) const

privatevirtual

useful to chain

Reimplemented from Checkable.

std::string name ( ) const

inherited

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by LibraryBuilder::create_decay_transitions(), LibraryBuilder::create_reaction_transitions(), ChannelType_Fiss::good_impl(), ChannelType_Decay::good_impl(), ChannelType_Reac::good_impl(), and TEST().

void get_name ( std::string &  name ) const

inherited

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

void set_name ( std::string  name )

inherited

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

int id ( ) const

inherited

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TransitionSystem_Gen::add_nuclide_impl(), TransitionSystem_Gen::add_species_impl(), Channel_Gen::add_transition_impl(), LibraryBuilder::create_decay_transitions(), LibraryBuilder::create_reaction_transitions(), Nuclide_Gen::gain_impl(), LibraryBuilder::search_reaction_transitions(), Nuclide_Gen::set_losses_impl(), Channel_Gen::set_transition_impl(), TEST(), and TEST_F().

void get_id ( int &  id ) const

inherited

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

void set_id ( int  id )

inherited

Examples:

tstTransitionSystem_Gen.cpp.

Referenced by TEST().

bool has_initialized_id ( ) const

inherited

Referenced by Nuclide_Gen::set_losses_impl(), TransitionSystem_Gen::set_nuclides_impl(), and Channel_Gen::set_transitions_impl().

std::string to_string ( ) const

inherited

Examples:

tstTransitionSystemAdapter_AmpxN.cpp.

Referenced by TEST_F().

bool good ( ) const

inherited

bool good ( Vec_Str &  errors ) const

inherited

bool is_initialized ( ) const

inherited

Referenced by ChannelType_Decay::good_impl(), and ChannelType_Decay::update_byproducts().

Scale::Json::Value to_json ( ) const

inherited

---

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

• Core/ts/Species.h
• Core/ts/Species.cpp