GIDI::Distributions::Distribution Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Distributions::Distribution:

Public Member Functions
	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
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 the base class inherited by all distribution form classes.

Definition at line 2228 of file GIDI.hpp.

Constructor & Destructor Documentation

Distribution() [1/2]

GIDI::Distributions::Distribution::Distribution	(	std::string const &	a_moniker,
		FormType	a_type,
		std::string const &	a_label,
		Frame	a_productFrame )

Parameters

a_moniker	[in] The GNDS moniker for the distribution.
a_type	[in] The FormType for the distribution form.
a_label	[in] The label for the distribution.
a_productFrame	[in] The frame the product data are in.

Definition at line 29 of file GIDI_distributions.cc.

                                                                                                                        :
        Form( a_moniker, a_type, a_label ),
        m_productFrame( a_productFrame ) {
 
}

Referenced by GIDI::Distributions::AngularEnergy::AngularEnergy(), GIDI::Distributions::AngularEnergyMC::AngularEnergyMC(), GIDI::Distributions::AngularTwoBody::AngularTwoBody(), GIDI::Distributions::AngularTwoBody::AngularTwoBody(), GIDI::Distributions::CoulombPlusNuclearElastic::CoulombPlusNuclearElastic(), GIDI::Distributions::EnergyAngular::EnergyAngular(), GIDI::Distributions::EnergyAngularMC::EnergyAngularMC(), GIDI::Distributions::KalbachMann::KalbachMann(), GIDI::Distributions::LLNLAngularEnergy::LLNLAngularEnergy(), GIDI::Distributions::LLNLLegendre::LLNLLegendre(), GIDI::Distributions::MultiGroup3d::MultiGroup3d(), GIDI::Distributions::Reference3d::Reference3d(), GIDI::Distributions::ThermalNeutronScatteringLaw::ThermalNeutronScatteringLaw(), and GIDI::Distributions::Uncorrelated::Uncorrelated().

Distribution() [2/2]

GIDI::Distributions::Distribution::Distribution	(	HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		FormType	a_type,
		Suite *	a_parent )

Parameters

a_node	[in] The HAPI::Node to be parsed and used to construct the distribution.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_type	[in] The FormType for the distribution form.
a_parent	[in] The m_distribution member of GIDI::Product this distribution form belongs to.

Definition at line 43 of file GIDI_distributions.cc.

                                                                                                             :
        Form( a_node, a_setupInfo, a_type, a_parent ),
        m_productFrame( parseFrame( a_node, a_setupInfo, GIDI_productFrameChars ) ) {
 
}

Member Function Documentation

productFrame()

Frame GIDI::Distributions::Distribution::productFrame ( ) const

inline

Returns the value of the m_productFrame member.

Definition at line 2237 of file GIDI.hpp.

toXMLNodeStarter()

void GIDI::Distributions::Distribution::toXMLNodeStarter	(	GUPI::WriteInfo &	a_writeInfo,
		std::string const &	a_indent = "" ) const

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.

Definition at line 56 of file GIDI_distributions.cc.

                                                                                                 {
 
    std::string attributes;
 
    attributes += a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
    attributes += a_writeInfo.addAttribute( GIDI_productFrameChars, frameToString( m_productFrame ) );
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
}

Referenced by GIDI::Distributions::AngularEnergy::toXMLList(), GIDI::Distributions::AngularEnergyMC::toXMLList(), GIDI::Distributions::AngularTwoBody::toXMLList(), GIDI::Distributions::EnergyAngular::toXMLList(), GIDI::Distributions::EnergyAngularMC::toXMLList(), GIDI::Distributions::KalbachMann::toXMLList(), GIDI::Distributions::LLNLAngularEnergy::toXMLList(), GIDI::Distributions::MultiGroup3d::toXMLList(), GIDI::Distributions::Uncorrelated::toXMLList(), and GIDI::Distributions::Unspecified::toXMLList().

---

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

• GIDI.hpp
• GIDI_distributions.cc