GUPI::Entry Class Reference

#include <GUPI.hpp>

Inheritance diagram for GUPI::Entry:

Public Member Functions
	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
virtual void	toXMLList (WriteInfo &a_writeInfo, std::string const &a_indent="") 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

This is a base class inherit by other classes that are enties in a Suite.

Definition at line 140 of file GUPI.hpp.

Constructor & Destructor Documentation

Entry() [1/2]

GUPI::Entry::Entry	(	std::string const &	a_moniker,
		std::string const &	a_keyName,
		std::string const &	a_keyValue )

Parameters

a_moniker	[in] The GNDS node's name (i.e., moniker).
a_attribute	[in] Currently not used.

Definition at line 25 of file GUPI_entry.cc.

                                                                                                  :
        Ancestry( a_moniker ),
        m_keyName( a_keyName ),
        m_keyValue( a_keyValue ) {
 
}

Referenced by GIDI::TargetInfo::ChemicalElement::ChemicalElement(), and GIDI::TargetInfo::Nuclide::Nuclide().

Entry() [2/2]

GUPI::Entry::Entry	(	HAPI::Node const &	a_node,
		std::string const &	a_keyName )

Parameters

a_moniker	[in] The GNDS node's name (i.e., moniker).
a_attribute	[in] Currently not used.

Definition at line 37 of file GUPI_entry.cc.

                                                                 :
        Ancestry( a_node.name( ) ),
        m_keyName( a_keyName ),
        m_keyValue( a_node.attribute_as_string( a_keyName.c_str( ) ) ) {
 
}

~Entry()

GUPI::Entry::~Entry

(

)

Definition at line 47 of file GUPI_entry.cc.

               {
 
}

Member Function Documentation

findInAncestry3() [1/2]

Ancestry * GUPI::Entry::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item )

inline

Definition at line 154 of file GUPI.hpp.

{ return( nullptr ); }

findInAncestry3() [2/2]

Ancestry const * GUPI::Entry::findInAncestry3 ( LUPI_maybeUnused std::string const & a_item ) const

inline

Definition at line 155 of file GUPI.hpp.

{ return( nullptr ); }

keyName()

std::string const & GUPI::Entry::keyName ( ) const

inline

Returns a const reference to the m_keyName member.

Definition at line 151 of file GUPI.hpp.

keyValue()

std::string const & GUPI::Entry::keyValue ( ) const

inline

Returns a const reference to the m_keyValue member.

Definition at line 152 of file GUPI.hpp.

Referenced by GUPI::Suite::add(), GIDI::TargetInfo::Nuclide::pid(), and GIDI::TargetInfo::ChemicalElement::symbol().

serialize()

LUPI_HOST void GUPI::Entry::serialize ( LUPI::DataBuffer & a_buffer, LUPI::DataBuffer::Mode a_mode )

virtual

This method serializes this for broadcasting as needed for MPI and GPUs. The method can count the number of required bytes, pack this or unpack this depending on a_mode.

Parameters

a_buffer	[in] The buffer to read or write data to depending on a_mode.
a_mode	[in] Specifies the action of this method.

Reimplemented from GUPI::Ancestry.

Definition at line 59 of file GUPI_entry.cc.

                                                                                     {
 
    Ancestry::serialize( a_buffer, a_mode );
    DATA_MEMBER_STD_STRING( m_keyName, a_buffer, a_mode );
    DATA_MEMBER_STD_STRING( m_keyValue, a_buffer, a_mode );
}

xlinkItemKey()

std::string GUPI::Entry::xlinkItemKey ( ) const

inlinevirtual

Returns the value of this's key.

Reimplemented from GUPI::Ancestry.

Definition at line 157 of file GUPI.hpp.

                                        {
 
            if( m_keyValue == "" ) return( "" );
            return( buildXLinkItemKey( m_keyName, m_keyValue ) );
        } 

---

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

• GUPI.hpp
• GUPI_entry.cc