Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
LibraryHeader Class Reference

#include <LibraryHeader.h>

Inheritance diagram for LibraryHeader:

Public Types

typedef std::shared_ptr< LibraryHeader > SP
 
typedef std::shared_ptr< const LibraryHeader > SCP
 

Public Member Functions

 LibraryHeader ()
 
std::string to_string () const
 
Scale::Json::Value to_json () const
 
bool operator== (const LibraryHeader &a) const
 
std::string print_compare (const LibraryHeader &a) const
 
const NuclideSet & nuclide_set () const
 return a const reference to nuclide_set More...
 
SCP_NuclideSet scp_nuclide_set () const
 return a shared (read-only) nuclide_set pointer More...
 
bool has_nuclide_set () const
 return whether the class has a non-null nuclide_set More...
 
void get_nuclide_set (NuclideSet &) const
 populate an existing NuclideSet with a copy of nuclide_set More...
 
void set_nuclide_set (const NuclideSet &)
 set the nuclide_set (copy operation) More...
 
void getptr_nuclide_set (const NuclideSet *&) const
 retrieve pointer (read-only) to nuclide_set More...
 
void manageptr_nuclide_set (NuclideSet *&)
 set the nuclide_set (ownership transfer) More...
 
virtual int serialize (Standard::AbstractStream *stream) const
 
virtual int deserialize (Standard::AbstractStream *stream)
 
virtual unsigned long getSerializedSize () const
 
virtual LibraryHeader * getCopy () const
 
virtual long getUID () const
 
virtual bool childOf (long parentUID) const
 
virtual std::string toString () const
 
void set_month_made (int)
 set the scalar month_made More...
 
int month_made () const
 return the scalar month_made More...
 
void set_day_made (int)
 set the scalar day_made More...
 
int day_made () const
 return the scalar day_made More...
 
void set_year_made (int)
 set the scalar year_made More...
 
int year_made () const
 return the scalar year_made More...
 
void set_title (std::string)
 set the scalar title More...
 
std::string title () const
 return the scalar title More...
 
size_t total_nuclides () const
 

Static Public Attributes

static const long uid = 0x99514754f6b0dc5d
 

Protected Member Functions

void canonicalize_nuclide_set ()
 

Protected Attributes

SP_NuclideSet b_nuclide_set
 
int b_month_made
 
int b_day_made
 
int b_year_made
 
std::string b_title
 

Friends

class ScaleUtils::IO::Accessor< Origen::LibraryHeader >
 

Detailed Description

Examples:
tstDecayData.cpp, tstLibrary.cpp, tstLibraryHeader.cpp, tstLibraryIO.cpp, tstTransitionCoeff.cpp, tstTransitionStructure.cpp, and tstTransitionSystemAdapter_DecayResource.cpp.

Member Typedef Documentation

typedef std::shared_ptr<LibraryHeader> SP
typedef std::shared_ptr<const LibraryHeader> SCP

Constructor & Destructor Documentation

LibraryHeader ( )

Referenced by LibraryHeader::getCopy().

Member Function Documentation

std::string to_string ( ) const

References LibraryHeader::to_json().

Referenced by LibraryHeader::toString().

Json::Value to_json ( ) const

References LibraryHeader::b_day_made, LibraryHeader::b_month_made, LibraryHeader::b_nuclide_set, LibraryHeader::b_title, LibraryHeader::b_year_made, LibraryHeader::has_nuclide_set(), and LibraryHeader::uid.

Referenced by LibraryHeader::to_string().

bool operator== ( const LibraryHeader &  a) const

References LibraryHeader::b_day_made, LibraryHeader::b_month_made, LibraryHeader::b_nuclide_set, LibraryHeader::b_title, LibraryHeader::b_year_made, LibraryHeader::day_made(), LibraryHeader::month_made(), LibraryHeader::nuclide_set(), LibraryHeader::title(), and LibraryHeader::year_made().

std::string print_compare ( const LibraryHeader &  a) const

References LibraryHeader::b_day_made, LibraryHeader::b_month_made, LibraryHeader::b_nuclide_set, LibraryHeader::b_title, and LibraryHeader::b_year_made.

const NuclideSet & nuclide_set ( ) const

return a const reference to nuclide_set

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Invalid if this instance of LibraryHeader goes out of scope.

Examples:
tstNuclideSet.cpp, tstTransitionSystemAdapter_AmpxN.cpp, and tstTransitionSystemAdapter_DecayResource.cpp.

Referenced by Origen::construct_coeff_map(), Origen::construct_neutron_prod_map(), Origen::construct_neutron_yields_map(), Origen::createDecayData_random1(), Origen::createTransitionCoeff_random1(), Origen::createTransitionStructure_random1(), DecayResource::DecayResource(), get_decay_data(), get_transition_data(), Origen::graphvizLibrary(), gtestLibraryMasses(), gtestLibrarySizes(), inject_fission_yields(), TransitionMatrixUpdater::load(), LibraryHeader::operator==(), Library::populate_transition_matrix(), Origen::populateLibraryAbundance_NuclideResource(), Origen::populateLibraryDecayEnergy_DecayResource(), Origen::populateLibraryMass(), Origen::populateLibraryMass_NuclideResource(), Origen::populateLibraryToxicity_DecayResource(), LibraryIO_bof::read(), LibraryIO_s61::read(), LibraryIO_s62b::read(), Origen::tabulateFissionXs(), Origen::tabulateLossXs(), Origen::tabulateNuclideInfo(), Origen::tabulateReactionTransitions(), Origen::tabulateTransitionCoeff(), TEST(), TEST_F(), Origen::thinLibrary(), LibraryIO_bof::write(), LibraryIO_s62b::write(), and LibraryIO_s61::write().

SCP_NuclideSet scp_nuclide_set ( ) const

return a shared (read-only) nuclide_set pointer

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

bool has_nuclide_set ( ) const

return whether the class has a non-null nuclide_set

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Referenced by Library::populate_transition_matrix(), LibraryHeader::to_json(), and LibraryHeader::total_nuclides().

void get_nuclide_set ( NuclideSet &  nuclide_set) const

populate an existing NuclideSet with a copy of nuclide_set

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void set_nuclide_set ( const NuclideSet &  nuclide_set)

set the nuclide_set (copy operation)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Examples:
tstLibrary.cpp.

Referenced by LibraryBuilder::create_library(), FakeFactory::createLibraryHeader_random1(), FakeFactory::newspLibrary_10nuclide(), Origen::populateLibraryHeader_YieldResource(), LibraryIO_bof::read(), LibraryIO_s62b::read(), LibraryIO_s61::read(), and LibraryTest::SetUp().

void getptr_nuclide_set ( const NuclideSet *&  ) const

retrieve pointer (read-only) to nuclide_set

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void manageptr_nuclide_set ( NuclideSet *&  nuclide_set)

set the nuclide_set (ownership transfer)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

int serialize ( Standard::AbstractStream *  stream) const
virtual
Examples:
tstLibraryHeader.cpp.

References LibraryHeader::b_day_made, LibraryHeader::b_month_made, LibraryHeader::b_nuclide_set, LibraryHeader::b_title, LibraryHeader::b_year_made, LibraryHeader::getSerializedSize(), and Origen::write().

Referenced by TEST().

int deserialize ( Standard::AbstractStream *  stream)
virtual
Examples:
tstLibraryHeader.cpp.

References LibraryHeader::b_day_made, LibraryHeader::b_month_made, LibraryHeader::b_nuclide_set, LibraryHeader::b_title, LibraryHeader::b_year_made, LibraryHeader::canonicalize_nuclide_set(), LibraryHeader::getSerializedSize(), and Origen::read().

Referenced by TEST().

unsigned long getSerializedSize ( ) const
virtual

References LibraryHeader::b_day_made, LibraryHeader::b_month_made, LibraryHeader::b_nuclide_set, LibraryHeader::b_title, and LibraryHeader::b_year_made.

Referenced by LibraryHeader::deserialize(), and LibraryHeader::serialize().

LibraryHeader * getCopy ( ) const
virtual

References LibraryHeader::LibraryHeader().

long getUID ( ) const
virtual

References LibraryHeader::uid.

bool childOf ( long  parentUID) const
virtual
std::string toString ( ) const
virtual

References LibraryHeader::to_string().

void set_month_made ( int  scalar)

set the scalar month_made

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Examples:
tstLibrary.cpp.

Referenced by LibraryBuilder::create_library(), FakeFactory::createLibraryHeader_random1(), LibraryIO_s62b::read(), LibraryIO_s61::read(), LibraryIO_bof::read(), and LibraryTest::SetUp().

int month_made ( ) const

return the scalar month_made

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Referenced by LibraryHeader::operator==(), Library::populate_transition_matrix(), LibraryIO_s61::write(), LibraryIO_bof::write(), and LibraryIO_s62b::write().

void set_day_made ( int  scalar)

set the scalar day_made

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Examples:
tstLibrary.cpp.

Referenced by LibraryBuilder::create_library(), FakeFactory::createLibraryHeader_random1(), LibraryIO_s62b::read(), LibraryIO_s61::read(), LibraryIO_bof::read(), and LibraryTest::SetUp().

int day_made ( ) const

return the scalar day_made

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Referenced by LibraryHeader::operator==(), Library::populate_transition_matrix(), LibraryIO_s61::write(), LibraryIO_bof::write(), and LibraryIO_s62b::write().

void set_year_made ( int  scalar)

set the scalar year_made

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Examples:
tstLibrary.cpp.

Referenced by LibraryBuilder::create_library(), FakeFactory::createLibraryHeader_random1(), LibraryIO_s62b::read(), LibraryIO_s61::read(), LibraryIO_bof::read(), and LibraryTest::SetUp().

int year_made ( ) const

return the scalar year_made

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Referenced by LibraryHeader::operator==(), Library::populate_transition_matrix(), LibraryIO_s61::write(), LibraryIO_bof::write(), and LibraryIO_s62b::write().

void set_title ( std::string  scalar)

set the scalar title

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Examples:
tstLibrary.cpp.

Referenced by FakeFactory::createLibraryHeader_random1(), LibraryIO_s62b::read(), LibraryIO_s61::read(), LibraryIO_bof::read(), and LibraryTest::SetUp().

std::string title ( ) const

return the scalar title

Auto-generated from macro \ #ORIGEN_ACCESSORS_SCALAR().

Referenced by LibraryHeader::operator==(), Library::populate_transition_matrix(), LibraryIO_s61::write(), LibraryIO_bof::write(), and LibraryIO_s62b::write().

size_t total_nuclides ( ) const
Examples:
tstTransitionSystemAdapter_DecayResource.cpp.

References LibraryHeader::b_nuclide_set, and LibraryHeader::has_nuclide_set().

Referenced by get_decay_data(), get_transition_data(), gtestLibrarySizes(), and inject_fission_yields().

void canonicalize_nuclide_set ( )
protected

Referenced by LibraryHeader::deserialize().

Friends And Related Function Documentation

friend class ScaleUtils::IO::Accessor< Origen::LibraryHeader >
friend

Member Data Documentation

const long uid = 0x99514754f6b0dc5d
static

Referenced by Library::deserialize(), LibraryHeader::getUID(), Origen_LibraryHeader_uid(), and LibraryHeader::to_json().

SP_NuclideSet b_nuclide_set
protected

Referenced by LibraryHeader::deserialize(), LibraryHeader::getSerializedSize(), LibraryHeader::operator==(), LibraryHeader::print_compare(), Accessor< Origen::LibraryHeader >::read(), LibraryHeader::serialize(), LibraryHeader::to_json(), and LibraryHeader::total_nuclides().

int b_month_made
protected

Month library was made (nmonth)

Referenced by LibraryHeader::deserialize(), LibraryHeader::getSerializedSize(), LibraryHeader::operator==(), LibraryHeader::print_compare(), Accessor< Origen::LibraryHeader >::read(), LibraryHeader::serialize(), and LibraryHeader::to_json().

int b_day_made
protected

Day library was made (nday)

Referenced by LibraryHeader::deserialize(), LibraryHeader::getSerializedSize(), LibraryHeader::operator==(), LibraryHeader::print_compare(), Accessor< Origen::LibraryHeader >::read(), LibraryHeader::serialize(), and LibraryHeader::to_json().

int b_year_made
protected

year library was made (nyear)

Referenced by LibraryHeader::deserialize(), LibraryHeader::getSerializedSize(), LibraryHeader::operator==(), LibraryHeader::print_compare(), Accessor< Origen::LibraryHeader >::read(), LibraryHeader::serialize(), and LibraryHeader::to_json().

std::string b_title
protected

Library title

Referenced by LibraryHeader::deserialize(), LibraryHeader::getSerializedSize(), LibraryHeader::operator==(), LibraryHeader::print_compare(), Accessor< Origen::LibraryHeader >::read(), LibraryHeader::serialize(), and LibraryHeader::to_json().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.10