#include <StateInfo.h>

Inheritance diagram for StateInfo:

Container for a State information tag. More...

Public Types
typedef std::shared_ptr< StateInfo >	SP

typedef std::shared_ptr< const StateInfo >	SCP

Public Member Functions
	StateInfo ()

virtual	~StateInfo ()

std::string	to_string () const

Scale::Json::Value	to_json () const

int	case_number () const

void	set_case_number (int)

int	step_number () const

void	set_step_number (int)

int	library_position () const

void	set_library_position (int)

bool	match (const StateInfo &b) const

void	accumulate_definition (const StateInfo &definition, float volume, float previous_volume=1.0)

float	power () const

void	set_power (float)

float	flux () const

void	set_flux (float)

float	time () const

void	set_time (float)

float	fluence () const

void	set_fluence (float)

float	energy () const

void	set_energy (float)

float	burnup () const

void	set_burnup (float)

const TagManager &	tag_manager () const
	return a const reference to tag_manager More...

SCP_TagManager	scp_tag_manager () const
	return a shared (read-only) tag_manager pointer More...

bool	has_tag_manager () const
	return whether the class has a non-null tag_manager More...

void	get_tag_manager (TagManager &) const
	populate an existing TagManager with a copy of tag_manager More...

void	set_tag_manager (const TagManager &)
	set the tag_manager (copy operation) More...

void	getptr_tag_manager (const TagManager *&) const
	retrieve pointer (read-only) to tag_manager More...

void	manageptr_tag_manager (TagManager *&)
	set the tag_manager (ownership transfer) More...

int	serialize (Standard::AbstractStream *stream) const

int	deserialize (Standard::AbstractStream *stream)

unsigned long	getSerializedSize () const

Standard::Serializable *	getCopy () const

virtual Standard::Serializable::UID	getUID () const

std::string	toString () const

Static Public Member Functions
static bool	match (const StateInfo &a, const StateInfo &b)

Static Public Attributes
static const Standard::Serializable::UID	uid = 0x0c298a37d502b3a8

Protected Member Functions
void	canonicalize_tag_manager ()

bool	isEqualStateInfo (const StateInfo &a) const

virtual bool	isEqual (const Standard::Serializable &b) const

Protected Attributes
int	b_case_number

int	b_step_number

int	b_library_position

float	b_power

float	b_flux

float	b_time

float	b_fluence

float	b_energy

SP_TagManager	b_tag_manager

Friends
class	GridView_StateInfo

class	State

class	ScaleUtils::IO::Accessor< StateInfo >

Detailed Description

Container for a State information tag.

This container is meant to function like a header for a Origen::State. It allows for interpolation of states and grouping of states. It is a small data structure and must be non-null on each State.

Examples:: tstGridView.cpp, tstState.cpp, and tstStateInfo.cpp.

Member Typedef Documentation

typedef std::shared_ptr<StateInfo> SP

typedef std::shared_ptr<const StateInfo> SCP

Constructor & Destructor Documentation

StateInfo ( )

Referenced by StateInfo::getCopy().

virtual ~StateInfo ( )

inlinevirtual

Member Function Documentation

std::string to_string ( ) const

References StateInfo::to_json().

Referenced by StateInfo::toString().

Json::Value to_json ( ) const

References StateInfo::b_case_number, StateInfo::b_energy, StateInfo::b_fluence, StateInfo::b_flux, StateInfo::b_library_position, StateInfo::b_power, StateInfo::b_step_number, StateInfo::b_tag_manager, StateInfo::b_time, and StateInfo::uid.

Referenced by StateInfo::to_string().

int case_number ( ) const

int - Case number in concentration file

Examples:: tstStateSet.cpp.

References StateInfo::b_case_number.

Referenced by StateInfo::match(), StateSet::matching_states(), StateSetIO_s62b::read(), StateSetIO_bof::read(), StateInfo::set_case_number(), TEST(), StateSetIO_s62b::write(), and Origen::write().

void set_case_number ( int case_number )

int - Set case number in concentration file

References StateInfo::b_case_number, and StateInfo::case_number().

Referenced by FakeFactory::newspStateSet_10nuclide(), StateSetIO_s61::read(), StateSetIO_s62b::read(), Origen::read(), Origen::saveStateSet(), and FakeFactory::StateSet_random1().

int step_number ( ) const

int - Step number in concentration file

References StateInfo::b_step_number.

Referenced by StateSetIO_bof::read(), StateSetIO_s62b::read(), StateInfo::set_step_number(), StateSetIO_s62b::write(), and Origen::write().

void set_step_number ( int step_number )

int - Set step number in concentration file

References StateInfo::b_step_number, and StateInfo::step_number().

Referenced by StateSetIO_s61::read(), StateSetIO_s62b::read(), Origen::read(), Origen::saveStateSet(), and FakeFactory::StateSet_random1().

int library_position ( ) const

int - Library position

References StateInfo::b_library_position.

Referenced by StateSetIO_bof::read(), StateSetIO_s62b::read(), StateInfo::set_library_position(), StateSetIO_s62b::write(), and Origen::write().

void set_library_position ( int library_position )

int - Set library position

References StateInfo::b_library_position, and StateInfo::library_position().

Referenced by FakeFactory::newspStateSet_10nuclide(), StateSetIO_s62b::read(), Origen::read(), Origen::saveStateSet(), and FakeFactory::StateSet_random1().

bool match	(	const StateInfo &	a,
		const StateInfo &	b
	)

static

References StateInfo::case_number(), TagManager::match(), and StateInfo::tag_manager().

Referenced by StateInfo::isEqualStateInfo(), GridView_StateInfo::match(), State::match(), and StateInfo::match().

bool match ( const StateInfo & b ) const

References StateInfo::match().

void accumulate_definition	(	const StateInfo &	definition,
		float	volume,
		float	previous_volume = `1.0`
	)

Examples:: tstStateInfo.cpp.

References StateInfo::b_energy, StateInfo::b_fluence, StateInfo::b_flux, StateInfo::b_power, StateInfo::energy(), StateInfo::fluence(), StateInfo::flux(), and StateInfo::power().

Referenced by TEST().

float power ( ) const

float - return power [MW]

Examples:: tstState.cpp, tstStateInfo.cpp, and tstStateSet.cpp.

References StateInfo::b_power.

Referenced by StateInfo::accumulate_definition(), StateSet::powers(), StateSetIO_s62b::read(), StateSetIO_bof::read(), StateInfo::set_power(), TEST(), StateSetIO_s62b::write(), and Origen::write().

void set_power ( float power )

float - set power [MW]

Examples:: tstState.cpp, and tstStateInfo.cpp.

References StateInfo::b_power, and StateInfo::power().

Referenced by StateSetIO_s61::read(), StateSetIO_s62b::read(), Origen::read(), Origen::saveStateSet(), FakeFactory::StateSet_random1(), and TEST().

float flux ( ) const

float - return flux [1/cm^2-s]

Examples:: tstState.cpp, tstStateInfo.cpp, and tstStateSet.cpp.

References StateInfo::b_flux.

Referenced by StateInfo::accumulate_definition(), StateSet::fluxes(), StateSetIO_s62b::read(), StateSetIO_bof::read(), StateInfo::set_flux(), TEST(), StateSetIO_s62b::write(), and Origen::write().

void set_flux ( float flux )

float - set flux [1/cm^2-s]

Examples:: tstState.cpp, and tstStateInfo.cpp.

References StateInfo::b_flux, and StateInfo::flux().

Referenced by FakeFactory::newspStateSet_10nuclide(), StateSetIO_s62b::read(), StateSetIO_s61::read(), Origen::read(), Origen::saveStateSet(), FakeFactory::StateSet_random1(), and TEST().

float time ( ) const

float - return time [s]

Examples:: tstStateInfo.cpp, and tstStateSet.cpp.

References StateInfo::b_time.

Referenced by StateSet::alpha_spectra(), StateSet::beta_spectra(), StateSet::check_headers(), StateSet::concs(), StateSet::gamma_spectra(), StateSet::nearest_time(), StateSet::neutron_spectra(), StateSetIO_s62b::read(), StateSetIO_bof::read(), StateInfo::set_time(), TEST(), StateSet::times(), StateSetIO_s62b::write(), and Origen::write().

void set_time ( float time )

float - set time [s]

Examples:: tstStateInfo.cpp.

References StateInfo::b_time, and StateInfo::time().

Referenced by FakeFactory::newspStateSet_10nuclide(), StateSetIO_s62b::read(), StateSetIO_s61::read(), Origen::read(), Origen::saveStateSet(), FakeFactory::StateSet_random1(), and TEST().

float fluence ( ) const

float - return fluence [1/cm^2]

Examples:: tstStateInfo.cpp.

References StateInfo::b_fluence.

Referenced by StateInfo::accumulate_definition(), StateInfo::set_fluence(), TEST(), and Origen::write().

void set_fluence ( float fluence )

float - set fluence [1/cm^2]

Examples:: tstStateInfo.cpp.

References StateInfo::b_fluence, and StateInfo::fluence().

Referenced by Origen::read(), and TEST().

float energy ( ) const

float - return energy released [MWd]

Examples:: tstStateInfo.cpp, and tstStateSet.cpp.

References StateInfo::b_energy.

Referenced by StateInfo::accumulate_definition(), StateSet::alpha_spectra(), StateSet::beta_spectra(), StateSet::check_headers(), StateSet::concs(), StateSet::energies(), StateSet::gamma_spectra(), StateSet::neutron_spectra(), StateSetIO_bof::read(), StateSetIO_s62b::read(), StateInfo::set_burnup(), StateInfo::set_energy(), TEST(), StateSetIO_s62b::write(), and Origen::write().

void set_energy ( float energy )

float - set energy released [MWd]

Examples:: tstStateInfo.cpp.

References StateInfo::b_energy, and StateInfo::energy().

Referenced by StateSetIO_s62b::read(), Origen::read(), FakeFactory::StateSet_random1(), and TEST().

float burnup ( ) const

float - return energy released [MWd]

References StateInfo::b_energy.

void set_burnup ( float energy )

float - set energy released [MWd]

References StateInfo::b_energy, and StateInfo::energy().

const TagManager & tag_manager ( ) const

return a const reference to tag_manager