GIDI::Distributions::AngularTwoBody Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Distributions::AngularTwoBody:

Public Member Functions
	AngularTwoBody (std::string const &a_label, Frame a_productFrame, Functions::Function2dForm *a_angular=nullptr)
	AngularTwoBody (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent)
	~AngularTwoBody ()
Functions::Function2dForm const *	angular () const
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
Public Member Functions inherited from GIDI::Distributions::Distribution
	Distribution (std::string const &a_moniker, FormType a_type, std::string const &a_label, Frame a_productFrame)
	Distribution (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_parent)
Frame	productFrame () const
void	toXMLNodeStarter (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 for the GNDS angularTwoBody node.

Definition at line 2246 of file GIDI.hpp.

Constructor & Destructor Documentation

AngularTwoBody() [1/2]

GIDI::Distributions::AngularTwoBody::AngularTwoBody	(	std::string const &	a_label,
		Frame	a_productFrame,
		Functions::Function2dForm *	a_angular = nullptr )

Parameters

a_label	[in] The label for this form.
a_productFrame	[in] The frame the product data as in.
a_angular	[in] The 2-d functional angular representation.

Definition at line 110 of file GIDI_distributions.cc.

                                                                                                                   :
        Distribution( GIDI_angularTwoBodyChars, FormType::angularTwoBody, a_label, a_productFrame ),
        m_angular( a_angular ) {
 
    if( a_angular != nullptr ) a_angular->setAncestor( this );
}

AngularTwoBody() [2/2]

GIDI::Distributions::AngularTwoBody::AngularTwoBody	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		Suite *	a_parent )

Parameters

a_construction	[in] Used to pass user options to the constructor.
a_node	[in] The HAPI::Node to be parsed and used to construct the AngularTwoBody.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_parent	[in] The m_distribution member of GIDI::Product this distribution form belongs to.

Definition at line 125 of file GIDI_distributions.cc.

                                                                                                                                            :
        Distribution( a_node, a_setupInfo, FormType::angularTwoBody, a_parent ),
        m_angular( data2dParse( a_construction, a_node.first_child( ), a_setupInfo, nullptr ) ) {
 
}

~AngularTwoBody()

GIDI::Distributions::AngularTwoBody::~AngularTwoBody

(

)

Definition at line 134 of file GIDI_distributions.cc.

                                 {
 
    delete m_angular;
}

Member Function Documentation

angular()

Functions::Function2dForm const * GIDI::Distributions::AngularTwoBody::angular ( ) const

inline

Returns the value of the m_angular member as a const pointer.

Definition at line 2256 of file GIDI.hpp.

toXMLList()

void GIDI::Distributions::AngularTwoBody::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 146 of file GIDI_distributions.cc.

                                                                                            {
    
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
 
    toXMLNodeStarter( a_writeInfo, a_indent );
    if( m_angular != nullptr ) m_angular->toXMLList( a_writeInfo, indent2 );
    a_writeInfo.addNodeEnder( moniker( ) );
}

---

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

• GIDI.hpp
• GIDI_distributions.cc