#include <GIDI.hpp>

Inheritance diagram for GIDI::Styles::Base:

Public Member Functions
	Base (HAPI::Node const &a_node, SetupInfo &a_setupInfo, GIDI::Suite *a_parent)
	~Base ()
std::string const &	date () const
std::string const &	label () const
std::string const &	derivedStyle () const
bool	hasDocumentation ()
GUPI::Documentation *	documentation ()
virtual PhysicalQuantity const &	temperature () const =0
Base const *	getDerivedStyle () const
Base const *	getDerivedStyle (std::string const &a_moniker) const
std::vector< Base const * >	chain () const
bool	isStyleInDerivedForm (Base const *a_style) const
std::string	baseXMLAttributes (GUPI::WriteInfo &a_writeInfo) 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 virtual base class inherited by all style classes. It handles the date and derivedFrom members.

Definition at line 3117 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Base()

GIDI::Styles::Base::Base	(	HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		GIDI::Suite *	a_parent )

Parameters

a_node	[in] The HAPI::Node to be parsed.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_parent	[in] The parent GIDI::Suite.

Definition at line 145 of file GIDI_styles.cc.

                                                                                : 
        Form( a_node, a_setupInfo, FormType::style, a_parent ),
        m_date( a_node.attribute_as_string( GIDI_dateChars ) ),
        m_label( a_node.attribute_as_string( GIDI_labelChars ) ),
        m_derivedStyle( a_node.attribute_as_string( GIDI_derivedFromChars ) ) {
 
    if( a_node.child( GUPI_documentationChars ).empty( ) ) {
        m_documentation = nullptr;
    } else {
        m_documentation = new GUPI::Documentation( a_node.child( GIDI_documentationChars ) );
    }
}

◆ ~Base()

GIDI::Styles::Base::~Base ( )

Definition at line 158 of file GIDI_styles.cc.

             {
 
    delete m_documentation;
 
}

Member Function Documentation

◆ baseXMLAttributes()

std::string GIDI::Styles::Base::baseXMLAttributes ( GUPI::WriteInfo & a_writeInfo ) const

Returns the base attributes for this as a std::string instance.

Parameters

a_writeInfo [in/out] Instance containing incremental indentation and other information and stores the appended lines.

Returns: The base attributes as a XML attribute string.

Definition at line 241 of file GIDI_styles.cc.

                                                                    {
 
    std::string attributes( a_writeInfo.addAttribute( GIDI_labelChars, label( ) ) );
 
    if( m_derivedStyle != "" ) attributes += a_writeInfo.addAttribute( GIDI_derivedFromChars, m_derivedStyle );
    attributes += a_writeInfo.addAttribute( GIDI_dateChars, m_date );
 
    return( attributes );
}

◆ chain()

std::vector< Base const * > GIDI::Styles::Base::chain ( ) const

Thie method returns the list of self and all its derived from styles in reverse order (i.e, the first style in the list is this).

Returns: The list of derived styles of this (includng this) in reverse order.

Definition at line 200 of file GIDI_styles.cc.

                                           {
 
    std::vector<Base const *> chain1;
 
    Base const *style = this;
    while( style != nullptr ) {
        chain1.push_back( style );
        style = style->getDerivedStyle( );
    }
 
    return( chain1 );
}

Referenced by GIDI::Styles::Suite::chains(), and temperature().

◆ date()

std::string const & GIDI::Styles::Base::date ( ) const

inline

Returns the value of the m_date member.

Definition at line 3129 of file GIDI.hpp.

◆ derivedStyle()

std::string const & GIDI::Styles::Base::derivedStyle ( ) const

inline

Returns the value of the m_derivedStyle member.

Definition at line 3131 of file GIDI.hpp.

◆ documentation()

GUPI::Documentation * GIDI::Styles::Base::documentation ( )

inline

Definition at line 3133 of file GIDI.hpp.

3133{ return ( m_documentation ); }

◆ getDerivedStyle() [1/2]

Base const * GIDI::Styles::Base::getDerivedStyle ( ) const

Returns a pointer to the derivedFrom style of this.

Returns: Pointer to the derivedFrom style of this.

Definition at line 170 of file GIDI_styles.cc.

                                         {
 
    Form const *_form( sibling( m_derivedStyle ) );
 
    return( dynamic_cast<Base const *>( _form ) );
}

◆ getDerivedStyle() [2/2]

Base const * GIDI::Styles::Base::getDerivedStyle ( std::string const & a_moniker ) const

Starting at this's derivedFrom style, and ascending as needed, returns the derivedFrom style whose moniker is a_moniker.

Parameters

a_moniker [in] The moniker to search for.

Returns: The style whose moniker is a_moniker.

Definition at line 184 of file GIDI_styles.cc.

                                                                    {
 
    Form const *_form( sibling( m_derivedStyle ) );
    Base const *_style = dynamic_cast<Base const *>( _form );
 
    if( _style == nullptr ) return( _style );
    if( _style->moniker( ) != a_moniker ) _style = _style->getDerivedStyle( a_moniker );
    return( _style );
}

◆ hasDocumentation()

bool GIDI::Styles::Base::hasDocumentation ( )

inline

Definition at line 3132 of file GIDI.hpp.

3132{ return ( m_documentation != nullptr ); }

◆ isStyleInDerivedForm()

bool GIDI::Styles::Base::isStyleInDerivedForm ( Base const * a_style ) const

This method returns true if a_style is in this derivedFrom list and false otherwise.

Parameters

a_style [in] The style to check for.

Returns: The list of derived styles of this (includng this) in reverse order.

Definition at line 221 of file GIDI_styles.cc.

                                                           {
 
    Base const *style = getDerivedStyle( );
 
    while( style != nullptr ) {
        if( style == a_style ) return( true );
        style = style->getDerivedStyle( );
    }
 
    return( false );
}

Referenced by temperature().

◆ label()

std::string const & GIDI::Styles::Base::label ( ) const

inline

Returns the value of the m_label member.

Definition at line 3130 of file GIDI.hpp.

Referenced by baseXMLAttributes(), GIDI::ProtareSingle::muCutoffForCoulombPlusNuclearElastic(), GIDI::Reaction::Reaction(), and GIDI::ProtareSingle::temperatures().

◆ temperature()

virtual PhysicalQuantity const & GIDI::Styles::Base::temperature ( ) const

pure virtual

Implemented in GIDI::Styles::AngularDistributionReconstructed, GIDI::Styles::AverageProductData, GIDI::Styles::CoulombPlusNuclearElasticMuCutoff, GIDI::Styles::CrossSectionReconstructed, GIDI::Styles::Evaluated, GIDI::Styles::GriddedCrossSection, GIDI::Styles::Heated, GIDI::Styles::HeatedMultiGroup, GIDI::Styles::MonteCarlo_cdf, GIDI::Styles::MultiGroup, GIDI::Styles::Realization, GIDI::Styles::SnElasticUpScatter, and GIDI::Styles::URR_probabilityTables.

Referenced by GIDI::ProtareSingle::temperatures().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Base()

◆ ~Base()

Member Function Documentation

◆ baseXMLAttributes()

◆ chain()

◆ date()

◆ derivedStyle()

◆ documentation()

◆ getDerivedStyle() [1/2]

◆ getDerivedStyle() [2/2]

◆ hasDocumentation()

◆ isStyleInDerivedForm()

◆ label()

◆ temperature()