GIDI::AxisDomain Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::AxisDomain:

Public Member Functions
	AxisDomain (HAPI::Node const &a_node, SetupInfo &a_setupInfo)
	AxisDomain (double m_minimum, double m_maximum, std::string const &a_unit)
	~AxisDomain ()
double	minimum () const
double	maximum () const
std::string const &	unit () const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) 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 the minimum and maximum limits for a domain (i.e., a section of an axis) and its unit.

Definition at line 775 of file GIDI.hpp.

Constructor & Destructor Documentation

AxisDomain() [1/2]

GIDI::AxisDomain::AxisDomain	(	HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo )

Parameters

a_node	[in] The HAPI::Node to be parsed and used to construct the AxisDomain.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.

Definition at line 25 of file GIDI_axisDomain.cc.

                                                                       :
        Form( a_node, a_setupInfo, FormType::axisDomain ),
        m_minimum( a_node.attribute_as_double( GIDI_minChars ) ),
        m_maximum( a_node.attribute_as_double( GIDI_maxChars ) ),
        m_unit( a_node.attribute_as_string( GIDI_unitChars ) ) {
 
}

AxisDomain() [2/2]

GIDI::AxisDomain::AxisDomain	(	double	a_minimum,
		double	a_maximum,
		std::string const &	a_unit )

Parameters

a_minimum	[in] The domain's minimum value.
a_maximum	[in] The domain's maximum.
a_unit	[in] The domain's unit.

Definition at line 40 of file GIDI_axisDomain.cc.

                                                                                    :
        Form( FormType::axisDomain ),
        m_minimum( a_minimum ),
        m_maximum( a_maximum ),
        m_unit( a_unit ) {
 
}

~AxisDomain()

GIDI::AxisDomain::~AxisDomain

(

)

Definition at line 51 of file GIDI_axisDomain.cc.

                         {
 
}

Member Function Documentation

maximum()

double GIDI::AxisDomain::maximum ( ) const

inline

Returns the value of the m_maximum member.

Definition at line 788 of file GIDI.hpp.

Referenced by toXMLList().

minimum()

double GIDI::AxisDomain::minimum ( ) const

inline

Returns the value of the m_minimum member.

Definition at line 787 of file GIDI.hpp.

Referenced by toXMLList().

toXMLList()

void GIDI::AxisDomain::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 62 of file GIDI_axisDomain.cc.

                                                                                        {
 
    std::string attributes = a_writeInfo.addAttribute( GIDI_minChars, LUPI::Misc::doubleToShortestString( minimum( ) ) ) + 
                             a_writeInfo.addAttribute( GIDI_minChars, LUPI::Misc::doubleToShortestString( maximum( ) ) ) +
                             a_writeInfo.addAttribute( GIDI_unitChars, unit( ) );
 
    a_writeInfo.addNodeStarterEnder( a_indent, moniker( ), attributes );
}

unit()

std::string const & GIDI::AxisDomain::unit ( ) const

inline

Returns the value of the m_unit member.

Definition at line 789 of file GIDI.hpp.

Referenced by toXMLList().

---

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

• GIDI.hpp
• GIDI_axisDomain.cc