GIDI::TargetInfo::ChemicalElement Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::TargetInfo::ChemicalElement:

Public Member Functions
	ChemicalElement (HAPI::Node const &a_node)
	~ChemicalElement ()
GUPI::Suite &	nuclides ()
GUPI::Suite const &	nuclides () const
std::string const &	symbol () const
Nuclide const *	operator[] (std::string const &a_pid) const
GUPI::Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
Public Member Functions inherited from GUPI::Entry
	Entry (std::string const &a_moniker, std::string const &a_keyName, std::string const &a_keyValue)
	Entry (HAPI::Node const &a_node, std::string const &a_keyName)
	~Entry ()
std::string const &	keyName () const
std::string const &	keyValue () const
Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
std::string	xlinkItemKey () const
Public Member Functions inherited from GUPI::Ancestry
	Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual	~Ancestry ()
Ancestry &	operator= (Ancestry const &a_ancestry)
std::string const &	moniker () const
void	setMoniker (std::string const &a_moniker)
Ancestry *	ancestor ()
Ancestry const *	ancestor () const
void	setAncestor (Ancestry *a_ancestor)
std::string	attribute () const
Ancestry *	root ()
Ancestry const *	root () const
bool	isChild (Ancestry *a_instance)
bool	isParent (Ancestry *a_parent)
bool	isRoot () const
Ancestry *	findInAncestry (std::string const &a_href)
Ancestry const *	findInAncestry (std::string const &a_href) const
virtual Ancestry *	findInAncestry3 (std::string const &a_item)=0
virtual Ancestry const *	findInAncestry3 (std::string const &a_item) const =0
std::string	toXLink () const
void	printXML () const

Additional Inherited Members
Static Public Member Functions inherited from GUPI::Ancestry
static std::string	buildXLinkItemKey (std::string const &a_name, std::string const &a_key)

Detailed Description

The class that stores a chemicalElement node.

Definition at line 2951 of file GIDI.hpp.

Constructor & Destructor Documentation

ChemicalElement()

GIDI::TargetInfo::ChemicalElement::ChemicalElement

(

HAPI::Node const &

a_node

)

Definition at line 67 of file GIDI_targetInfo.cc.

                                                         :
        GUPI::Entry( a_node, PoPI_symbolChars ),
        m_nuclides( a_node.child( PoPI_nuclidesChars ), GIDI_pidChars, parseNuclide ) {
 
}

~ChemicalElement()

GIDI::TargetInfo::ChemicalElement::~ChemicalElement

(

)

Definition at line 76 of file GIDI_targetInfo.cc.

                                   {
 
}

Member Function Documentation

findInAncestry3() [1/2]

GUPI::Ancestry * GIDI::TargetInfo::ChemicalElement::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item )

inline

Definition at line 2965 of file GIDI.hpp.

{ return( nullptr ); }

findInAncestry3() [2/2]

GUPI::Ancestry const * GIDI::TargetInfo::ChemicalElement::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item ) const

inline

Definition at line 2966 of file GIDI.hpp.

{ return( nullptr ); }

nuclides() [1/2]

GUPI::Suite & GIDI::TargetInfo::ChemicalElement::nuclides ( )

inline

Definition at line 2960 of file GIDI.hpp.

{ return( m_nuclides ); }

nuclides() [2/2]

GUPI::Suite const & GIDI::TargetInfo::ChemicalElement::nuclides ( ) const

inline

Definition at line 2961 of file GIDI.hpp.

{ return( m_nuclides ); }

operator[]()

Nuclide const * GIDI::TargetInfo::ChemicalElement::operator[]

(

std::string const &

a_pid

)

const

Returns the Nuclide with pid a_pid if it exists; otherwise, nullptr is returned.

Parameters

a_symbol

[in] The symbol for the chemical element whose nuclide abundance data are being requested.

Definition at line 86 of file GIDI_targetInfo.cc.

                                                                         {
 
    for( auto nuclideIter = m_nuclides.begin( ); nuclideIter != m_nuclides.end( ); ++nuclideIter ) {
        Nuclide const *nuclide = static_cast<Nuclide *>( *nuclideIter );
        if( nuclide->pid( ) == a_pid ) return( nuclide );
    }
 
    return( nullptr );
}

symbol()

std::string const & GIDI::TargetInfo::ChemicalElement::symbol ( ) const

inline

Returns a const reference to the results of the call to the keyValue() method.

Definition at line 2963 of file GIDI.hpp.

Referenced by toXMLList().

toXMLList()

void GIDI::TargetInfo::ChemicalElement::toXMLList ( GUPI::WriteInfo & a_writeInfo, std::string const & a_indent = "" ) const

virtual

Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.

Parameters

a_writeInfo	[in/out] Instance containing incremental indentation and other information and stores the appended lines.
a_indent	[in] The amount to indent this node.

Reimplemented from GUPI::Ancestry.

Definition at line 103 of file GIDI_targetInfo.cc.

                                                                                             {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes;
 
    attributes  = a_writeInfo.addAttribute( PoPI_symbolChars, symbol( ) );
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
    m_nuclides.toXMLList( a_writeInfo, indent2 );
    a_writeInfo.addNodeEnder( moniker( ) );
}

---

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

• GIDI.hpp
• GIDI_targetInfo.cc