GIDI::Grid Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Grid:

Public Member Functions
	Grid (HAPI::Node const &a_node, SetupInfo &a_setupInfo, int a_useSystem_strtod)
	Grid (Grid const &a_grid)
std::size_t	size () const
double &	operator[] (std::size_t a_index) noexcept
std::string const &	style () const
std::string	keyName () const
std::string	keyValue () const
std::string	valueType () const
std::string const &	interpolation () const
nf_Buffer< double > const &	values () const
nf_Buffer< double > const &	data () const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
Public Member Functions inherited from GIDI::Axis
	Axis (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type=FormType::axis)
	Axis (int a_index, std::string const &a_label, std::string const &a_unit, FormType a_type=FormType::axis)
	Axis (Axis const &a_axis)
virtual	~Axis ()
int	index () const
std::string const &	unit () const
std::string const &	href () const
Public Member Functions inherited from GIDI::Form
	Form (FormType a_type)
	Form (std::string const &a_moniker, FormType a_type, std::string const &a_label)
	Form (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Form (Form const &a_form)
virtual	~Form ()
Form &	operator= (Form const &a_rhs)
Suite *	parent () const
std::string const &	label () const
void	setLabel (std::string const &a_label)
virtual std::string	actualMoniker () const
std::string const &	keyName () const
void	setKeyName (std::string const &a_keyName)
std::string const &	keyValue () const
virtual void	setKeyValue (std::string const &a_keyName) const
FormType	type () const
Form const *	sibling (std::string a_label) const
GUPI::Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
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
virtual LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
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

Class to store a GNDS grid node.

Definition at line 825 of file GIDI.hpp.

Constructor & Destructor Documentation

Grid() [1/2]

GIDI::Grid::Grid	(	HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		int	a_useSystem_strtod )

Parameters

a_node	[in] The HAPI::Node to be parsed and used to construct the Grid.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_useSystem_strtod	[in] Flag passed to the function nfu_stringToListOfDoubles.

Definition at line 26 of file GIDI_grid.cc.

                                                                                   :
        Axis( a_node, a_setupInfo, FormType::grid ),
        m_style( a_node.attribute_as_string( GIDI_styleChars ) ),
        m_keyName( GIDI_indexChars ),
        m_keyValue( a_node.attribute_as_string( GIDI_indexChars ) ),
        m_interpolation( a_node.attribute_as_string( GIDI_interpolationChars ) ) {
 
    if( href( ) == "" ) {
        HAPI::Node values = a_node.first_child( );
        if( values.name( ) != std::string( GIDI_valuesChars ) ) throw Exception( "grid's first child not values" );
 
        m_valueType = values.attribute_as_string( GIDI_valueTypeChars );
 
        parseValuesOfDoubles( values, a_setupInfo, m_values, a_useSystem_strtod );
    }
}

Referenced by Grid().

Grid() [2/2]

GIDI::Grid::Grid

(

Grid const &

a_grid

)

Copy constructor for Grid.

Parameters

a_grid

[in] The Grid instance to copy.

Definition at line 49 of file GIDI_grid.cc.

                               :
        Axis( a_grid ),
        m_style( a_grid.style( ) ),
        m_keyName( a_grid.keyName( ) ),
        m_keyValue( a_grid.keyValue( ) ),
        m_valueType( a_grid.valueType( ) ),
        m_values( a_grid.values( ) ) {
 
}

Member Function Documentation

data()

nf_Buffer< double > const & GIDI::Grid::data ( ) const

inline

Returns the value of the m_values member.

Definition at line 850 of file GIDI.hpp.

interpolation()

std::string const & GIDI::Grid::interpolation ( ) const

inline

Definition at line 847 of file GIDI.hpp.

{ return( m_interpolation ); }

keyName()

std::string GIDI::Grid::keyName ( ) const

inline

Returns the value of the m_keyName member.

Definition at line 843 of file GIDI.hpp.

Referenced by Grid().

keyValue()

std::string GIDI::Grid::keyValue ( ) const

inline

Returns the value of the m_keyValue member.

Definition at line 844 of file GIDI.hpp.

Referenced by Grid().

operator[]()

double & GIDI::Grid::operator[] ( std::size_t a_index )

inlinenoexcept

Returns the value at m_values[a_index].

Definition at line 840 of file GIDI.hpp.

size()

std::size_t GIDI::Grid::size ( ) const

inline

Returns the number of values in the m_values member.

Definition at line 839 of file GIDI.hpp.

style()

std::string const & GIDI::Grid::style ( ) const

inline

Returns the value of the m_style member.

Definition at line 842 of file GIDI.hpp.

Referenced by Grid(), and toXMLList().

toXMLList()

void GIDI::Grid::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 GIDI::Axis.

Definition at line 66 of file GIDI_grid.cc.

                                                                                  {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes = a_writeInfo.addAttribute( GIDI_indexChars, intToString( index( ) ) );
 
    if( href( ) == "" ) {
        attributes += a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
        attributes += a_writeInfo.addAttribute( GIDI_unitChars, unit( ) );
        attributes += a_writeInfo.addAttribute( GIDI_styleChars, style( ) );
        a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
        doublesToXMLList( a_writeInfo, indent2, m_values.vector(), 0, true, m_valueType );
        a_writeInfo.addNodeEnder( moniker( ) ); }
    else {
        attributes += a_writeInfo.addAttribute( GIDI_hrefChars, href( ) );
        a_writeInfo.addNodeStarterEnder( a_indent, moniker( ), attributes );
    }
}

values()

nf_Buffer< double > const & GIDI::Grid::values ( ) const

inline

Returns the value of the m_values member.

Definition at line 849 of file GIDI.hpp.

Referenced by Grid(), Grid(), GIDI::Reaction::modifyCrossSection(), and GIDI::ProtareTNSL::TNSL_crossSectionSumCorrection().

valueType()

std::string GIDI::Grid::valueType ( ) const

inline

Returns the value of the m_valueType member.

Definition at line 845 of file GIDI.hpp.

Referenced by Grid().

---

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

• GIDI.hpp
• GIDI_grid.cc