#include <GIDI.hpp>

Inheritance diagram for GIDI::Suite:

Public Types
typedef std::vector< Form * >	Forms
typedef Forms::iterator	iterator
typedef Forms::const_iterator	const_iterator

Public Member Functions
	Suite (std::string const &a_keyName=GIDI_labelChars)
	Suite (std::string const &a_moniker, std::string const &a_keyName)
	Suite (Construction::Settings const &a_construction, std::string const &a_moniker, std::string const &a_keyName, HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, PoPI::Database const &a_internalPoPs, parseSuite a_parseSuite, Styles::Suite const *a_styles, bool a_allowsLazyParsing=false)
	~Suite ()
std::string const &	keyName () const
std::size_t	size () const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
std::size_t	operator[] (std::string const &a_label) const
template<typename T>
T *	get (std::size_t a_Index)
template<typename T>
T const *	get (std::size_t a_Index) const
template<typename T>
T *	get (std::string const &a_label)
template<typename T>
T const *	get (std::string const &a_label) const
template<typename T>
T *	getViaLineage (std::string const &a_label)
template<typename T>
T *	getViaLineage (std::string const &a_label) const
template<typename T>
T *	pop (std::size_t a_Index)
template<typename T>
T *	pop (std::string const &a_label)
Styles::Suite const *	styles ()
std::string const &	href () const
void	parse (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, PoPI::Database const &a_internalPoPs, parseSuite a_parseSuite, Styles::Suite const *a_styles)
void	add (Form *a_form)
iterator	find (std::string const &a_label, bool a_convertLazyParsingHelperForm=false)
const_iterator	find (std::string const &a_label, bool a_convertLazyParsingHelperForm=false) const
bool	has (std::string const &a_label) const
Form *	checkLazyParsingHelperForm (std::size_t a_index)
Form *	checkLazyParsingHelperForm (std::size_t a_index) const
iterator	checkLazyParsingHelperFormIterator (iterator a_iter)
const_iterator	checkLazyParsingHelperFormIterator (const_iterator a_iter) const
void	modifiedMultiGroupElasticForTNSL (std::map< std::string, std::size_t > const &a_maximumTNSL_MultiGroupIndex)
GUPI::Ancestry *	findInAncestry3 (std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (std::string const &a_item) const
std::vector< iterator >	findAllOfMoniker (std::string const &a_moniker)
std::vector< const_iterator >	findAllOfMoniker (std::string const &a_moniker) const
Form const *	findInstanceOfTypeInLineage (std::string const &_label, std::string const &a_moniker) const
Form *	findInstanceOfTypeInLineage (Styles::Suite const &a_styles, std::string const &_label, std::string const &a_moniker)
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
void	printFormLabels (std::string const &a_header) const
template<typename T>
T const *	get (std::size_t a_index) const
template<typename T>
T const *	get (std::string const &a_label) const
template<typename T>
T const *	get (std::size_t a_index) const
template<typename T>
T const *	get (std::string const &a_label) 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 LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
virtual std::string	xlinkItemKey () const
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

This class is used to store a list (i.e., suite) of similar type GNDS nodes.

Definition at line 2567 of file GIDI.hpp.

Member Typedef Documentation

◆ const_iterator

typedef Forms::const_iterator GIDI::Suite::const_iterator

Definition at line 2593 of file GIDI.hpp.

◆ Forms

typedef std::vector<Form *> GIDI::Suite::Forms

The typedef the the m_forms member.

Definition at line 2570 of file GIDI.hpp.

◆ iterator

typedef Forms::iterator GIDI::Suite::iterator

Definition at line 2592 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Suite() [1/3]

GIDI::Suite::Suite ( std::string const & a_keyName = GIDI_labelChars )

Definition at line 22 of file GIDI_suite.cc.

                                         :
        GUPI::Ancestry( "" ),
        m_keyName( a_keyName ),
        m_styles( nullptr ),
        m_allowsLazyParsing( false ) {
 
}

Referenced by checkLazyParsingHelperForm(), GIDI::Component::Component(), GIDI::Component::Component(), GIDI::Fluxes::Fluxes(), GIDI::Fluxes::Fluxes(), GIDI::Groups::Groups(), and GIDI::Groups::Groups().

◆ Suite() [2/3]

GIDI::Suite::Suite	(	std::string const &	a_moniker,
		std::string const &	a_keyName )

Parameters

a_moniker	[in] The GNDS moniker for the Suite instance.
a_keyName	[in] The name of the key for elements of this.

Definition at line 35 of file GIDI_suite.cc.

                                                                     :
        GUPI::Ancestry( a_moniker ),
        m_keyName( a_keyName ),
        m_styles( nullptr ),
        m_allowsLazyParsing( false ) {
 
}

◆ Suite() [3/3]

GIDI::Suite::Suite	(	Construction::Settings const &	a_construction,
		std::string const &	a_moniker,
		std::string const &	a_keyName,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		PoPI::Database const &	a_pops,
		PoPI::Database const &	a_internalPoPs,
		parseSuite	a_parseSuite,
		Styles::Suite const *	a_styles,
		bool	a_allowsLazyParsing = false )

Parameters

a_construction	[in] Used to pass user options to the constructor.
a_moniker	[in] The GNDS moniker for the Suite instance.
a_node	[in] The HAPI::Node to be parsed and used to construct the Suite.
a_keyName	[in] The name of the key for referencing up child nodes.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_pops	[in] The external PoPI::Database instance used to get particle indices and possibly other particle information.
a_internalPoPs	[in] The internal PoPI::Database instance used to get particle indices and possibly other particle information. This is the <PoPs> node under the <reactionSuite> node.
a_parseSuite	[in] This function to call to parse each sub-node.
a_styles	[in] The <styles> node under the <reactionSuite> node.
a_allowsLazyParsing	[in] Boolean stating if the suite allows lazy parsing.

Definition at line 57 of file GIDI_suite.cc.

                                                                        :
        GUPI::Ancestry( a_moniker ),
        m_keyName( a_keyName ),
        m_styles( a_styles ),
        m_allowsLazyParsing( a_allowsLazyParsing ),
        m_href( "" ) {
 
    HAPI::Node const node = a_node.child( a_moniker.c_str( ) );
    m_href = node.attribute_as_string( GIDI_hrefChars );
 
    if( !node.empty( ) ) parse( a_construction, node, a_setupInfo, a_pops, a_internalPoPs, a_parseSuite, a_styles );
}

◆ ~Suite()

GIDI::Suite::~Suite ( )

Definition at line 75 of file GIDI_suite.cc.

               {
 
    for( std::vector<Form *>::const_iterator iter = m_forms.begin( ); iter < m_forms.end( ); ++iter ) delete *iter;
}

Member Function Documentation

◆ add()

void GIDI::Suite::add ( Form * a_form )

Adds the node a_form to this.

Parameters

a_form [in] The form to add.

Definition at line 132 of file GIDI_suite.cc.

                              {
 
    std::size_t i1 = 0;
 
    for( Suite::iterator iter = m_forms.begin( ); iter != m_forms.end( ); ++iter, ++i1 ) {
        if( (*iter)->keyValue( ) == a_form->keyValue( ) ) {
            m_forms[i1] = a_form;
            a_form->setAncestor( this );
            return;
        }
    }
    m_map[a_form->keyValue( )] = m_forms.size( );
    m_forms.push_back( a_form );
    a_form->setAncestor( this );
}

Referenced by GIDI::Fluxes::addFile(), GIDI::Groups::addFile(), GIDI::Documentation_1_10::Suite::parse(), and parse().

◆ begin() [1/2]

iterator GIDI::Suite::begin ( )

inline

The C++ begin iterator for this.

Definition at line 2594 of file GIDI.hpp.

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

◆ begin() [2/2]

const_iterator GIDI::Suite::begin ( ) const

inline

The C++ const begin iterator for this.

Definition at line 2595 of file GIDI.hpp.

◆ checkLazyParsingHelperForm() [1/2]

Form * GIDI::Suite::checkLazyParsingHelperForm ( std::size_t a_index )

Check to see if the form is a LazyParsingHelperForm, it so, parses the form, loads it before returning the requested form.

Parameters

a_index [in] The index of the child to return.

Returns: The form at index a_index.

Definition at line 156 of file GIDI_suite.cc.

                                                           {
 
    Form *form = m_forms[a_index];
 
    if( form->type( ) == FormType::lazyParsingHelperForm ) {
        LazyParsingHelperForm *lazyParsingHelperForm = static_cast<LazyParsingHelperForm *>( form );
        form = lazyParsingHelperForm->parse( );
        if( form == nullptr ) {             // Happens because several forms (e.g., CoulombPlusNuclearElastic) are not needed by transport codes and are not parsed.
            form = lazyParsingHelperForm; }
        else {
            form->setAncestor( this );
            m_forms[a_index] = form;
            delete lazyParsingHelperForm;
        }
    }
 
    return( form );
}

Referenced by checkLazyParsingHelperFormIterator(), checkLazyParsingHelperFormIterator(), get(), get(), get(), get(), pop(), and pop().

◆ checkLazyParsingHelperForm() [2/2]

Form * GIDI::Suite::checkLazyParsingHelperForm ( std::size_t a_index ) const

Check to see if the form is a LazyParsingHelperForm, it so, parses the form, loads it before returning the requested form.

Parameters

a_index [in] The index of the child to return.

Returns: The form at index a_index.

Definition at line 183 of file GIDI_suite.cc.

                                                                 {
 
    Form *form = m_forms[a_index];
 
    if( form->type( ) == FormType::lazyParsingHelperForm ) {
        LazyParsingHelperForm *lazyParsingHelperForm = static_cast<LazyParsingHelperForm *>( form );
        form = lazyParsingHelperForm->parse( );
        if( form != nullptr ) {
            form->setAncestor( const_cast<Suite *>( this ) );
            m_forms[a_index] = form;
            delete lazyParsingHelperForm;
        }
    }
 
    return( form );
}

◆ checkLazyParsingHelperFormIterator() [1/2]

Suite::const_iterator GIDI::Suite::checkLazyParsingHelperFormIterator ( Suite::const_iterator a_iter ) const

Check to see if the form is a LazyParsingHelperForm, it so, parses the form, loads it before returning the requested form.

Parameters

a_iter [in] Iterator to the Form to check.

Returns: The form at index a_index.

Definition at line 226 of file GIDI_suite.cc.

                                                                                                {
    
    if( a_iter == end( ) ) return( a_iter );
    
    std::size_t index = (*this)[(*a_iter)->keyValue()];
    a_iter++;
    checkLazyParsingHelperForm( index );
 
    return( --a_iter );
}

◆ checkLazyParsingHelperFormIterator() [2/2]

Suite::iterator GIDI::Suite::checkLazyParsingHelperFormIterator ( Suite::iterator a_iter )

Check to see if the form is a LazyParsingHelperForm, it so, parses the form, loads it before returning the requested form.

Parameters

a_iter [in] Iterator to the Form to check.

Returns: The iterator to the old or converted form.

Definition at line 207 of file GIDI_suite.cc.

                                                                              {
 
    if( a_iter == end( ) ) return( a_iter );
 
    std::size_t index = (*this)[(*a_iter)->keyValue()];
    ++a_iter;
    checkLazyParsingHelperForm( index );
 
    return( --a_iter );
}

Referenced by find(), find(), findInstanceOfTypeInLineage(), and findInstanceOfTypeInLineage().

◆ end() [1/2]

iterator GIDI::Suite::end ( )

inline

The C++ end iterator for this.

Definition at line 2596 of file GIDI.hpp.

Referenced by GIDI::Styles::Suite::chains(), checkLazyParsingHelperFormIterator(), checkLazyParsingHelperFormIterator(), MCGIDI::convertACE_URR_probabilityTablesFromGIDI(), findInstanceOfTypeInLineage(), GIDI::Styles::Suite::findLabelInLineage(), GIDI::Transporting::MG::form(), and GIDI::Reaction::recalculateMultiGroupData().

◆ end() [2/2]

const_iterator GIDI::Suite::end ( ) const

inline

The C++ const end iterator for this.

Definition at line 2597 of file GIDI.hpp.

◆ find() [1/2]

Suite::iterator GIDI::Suite::find	(	std::string const &	a_keyValue,
		bool	a_convertLazyParsingHelperForm = false )

Returns the iterator to the node with keyValue a_keyValue.

Parameters

a_keyValue	[in] The keyValue of the node to find.
a_convertLazyParsingHelperForm	[in] If true and requested form is a LazyParsingHelperForm instance, that instance is replaced with the parsed form.

Returns: The iterator to the node with keyValue a_keyValue.

Definition at line 246 of file GIDI_suite.cc.

                                                                                            {
 
    for( Suite::iterator iter = m_forms.begin( ); iter != m_forms.end( ); ++iter ) {
        if( (*iter)->keyValue( ) == a_keyValue ) {
            if( a_convertLazyParsingHelperForm ) return( checkLazyParsingHelperFormIterator( iter ) );
            return( iter );
        }
    }
    return( m_forms.end( ) );
}

Referenced by findInstanceOfTypeInLineage(), GIDI::Styles::Suite::findLabelInLineage(), GIDI::Transporting::MG::form(), has(), modifiedMultiGroupElasticForTNSL(), and GIDI::Reaction::recalculateMultiGroupData().

◆ find() [2/2]

Suite::const_iterator GIDI::Suite::find	(	std::string const &	a_keyValue,
		bool	a_convertLazyParsingHelperForm = false ) const

Returns the iterator to the node with keyValue a_keyValue.

Parameters

a_keyValue	[in] The keyValue of the node to find.
a_convertLazyParsingHelperForm	[in] If true and requested form is a LazyParsingHelperForm instance, that instance is replaced with the parsed form.

Returns: The iterator to the node with keyValue a_keyValue.

Definition at line 266 of file GIDI_suite.cc.

                                                                                                        {
 
    for( Suite::const_iterator iter = m_forms.begin( ); iter != m_forms.end( ); ++iter ) {
        if( (*iter)->keyValue( ) == a_keyValue ) {
            if( a_convertLazyParsingHelperForm ) return( checkLazyParsingHelperFormIterator( iter ) );
            return( iter );
        }
    }
    return( m_forms.end( ) );
}

◆ findAllOfMoniker() [1/2]

std::vector< Suite::iterator > GIDI::Suite::findAllOfMoniker ( std::string const & a_moniker )

Returns a list of iterators to the nodes in this that have GNDS moniker a_moniker.

Parameters

a_moniker [in] The moniker to search for.

Returns: List of iterators to the nodes in this that have moniker a_moniker.

Definition at line 285 of file GIDI_suite.cc.

                                                                             {
 
    std::vector<Suite::iterator> iters;
 
    for( Suite::iterator iter = m_forms.begin( ); iter != m_forms.end( ); ++iter ) {
        if( (*iter)->moniker( ) == a_moniker ) iters.push_back( iter );
    }
 
    return( iters );
}

Referenced by GIDI::Reaction::Reaction().

◆ findAllOfMoniker() [2/2]

std::vector< Suite::const_iterator > GIDI::Suite::findAllOfMoniker ( std::string const & a_moniker ) const

Returns a list of iterators to the nodes in this that have GNDS moniker a_moniker.

Parameters

a_moniker [in] The moniker to search for.

Returns: List of iterators to the nodes in this that have moniker a_moniker.

Definition at line 304 of file GIDI_suite.cc.

                                                                                         {
 
    std::vector<Suite::const_iterator> iters;
 
    for( Suite::const_iterator iter = m_forms.begin( ); iter != m_forms.end( ); ++iter ) {
        if( (*iter)->moniker( ) == a_moniker ) iters.push_back( iter );
    }
 
    return( iters );
}

◆ findInAncestry3() [1/2]

GUPI::Ancestry * GIDI::Suite::findInAncestry3 ( std::string const & a_item )

virtual

Used by GUPI::Ancestry to tranverse GNDS nodes. This method returns a pointer to a derived class' a_item member or nullptr if none exists.

Parameters

a_item [in] The name of the class member whose pointer is to be return.

Returns: The pointer to the class member or nullptr if class does not have a member named a_item.

Implements GUPI::Ancestry.

Definition at line 396 of file GIDI_suite.cc.

                                                              {
 
    std::size_t index( a_item.find( '=' ) ), lastQuote = a_item.size( ) - 2;
 
    if( index == std::string::npos ) return( nullptr );
    ++index;
    if( index > lastQuote ) throw Exception( "Suite::findInAncestry3: invalide xlink" );
    if( a_item[index] != '\'' ) throw Exception( "Suite::findInAncestry3: invalid xlink, missing '." );
    ++index;
    if( a_item[lastQuote]  != '\'' ) throw Exception( "Suite::findInAncestry3: invalid xlink, missing endl '." );
 
    std::string keyValue( a_item.substr( index, lastQuote - index ) );
 
    return( get<GUPI::Ancestry>( keyValue ) );
}

◆ findInAncestry3() [2/2]

GUPI::Ancestry const * GIDI::Suite::findInAncestry3 ( std::string const & a_item ) const

virtual

Used by GUPI::Ancestry to tranverse GNDS nodes. This method returns a pointer to a derived class' a_item member or nullptr if none exists.

Parameters

a_item [in] The name of the class member whose pointer is to be return.

Returns: The pointer to the class member or nullptr if class does not have a member named a_item.

Implements GUPI::Ancestry.

Definition at line 419 of file GIDI_suite.cc.

                                                                          {
 
    std::size_t index( a_item.find( '=' ) ), lastQuote = a_item.size( ) - 2;
 
    if( index == std::string::npos ) return( nullptr );
    ++index;
    if( index > lastQuote ) throw Exception( "Suite::findInAncestry3: invalide xlink" );
    if( a_item[index] != '\'' ) throw Exception( "Suite::findInAncestry3: invalid xlink, missing '." );
    ++index;
    if( a_item[lastQuote]  != '\'' ) throw Exception( "Suite::findInAncestry3: invalid xlink, missing endl '." );
 
    std::string keyValue( a_item.substr( index, lastQuote - index ) );
 
    return( get<GUPI::Ancestry>( keyValue ) );
}

◆ findInstanceOfTypeInLineage() [1/2]

Form const * GIDI::Suite::findInstanceOfTypeInLineage	(	std::string const &	a_label,
		std::string const &	a_moniker ) const

This method finds the nearest form of instance Functions::XYs1d in this that is prior to the form with label a_label.

Parameters

a_label	[in] The label of the form to start from when looking backwards.
a_formType	[in] The type of form to return.

Returns: Pointer to an Functions::XYs1d instance of nullptr if one not found.

Definition at line 324 of file GIDI_suite.cc.

                                                                                                           {
 
    Form const *form1 = nullptr;
    auto formIter = m_forms.end( );
 
    for( auto iter = m_forms.begin( ); iter != m_forms.end( ); ++iter ) {
        if( (*iter)->label( ) == a_label ) break;
        if( (*iter)->actualMoniker( ) == a_moniker ) formIter  = iter;
    }
 
    if( formIter != m_forms.end( ) ) {
        form1 = *checkLazyParsingHelperFormIterator( formIter );
    }
 
    return( form1 );
}

Referenced by GIDI::calculate1dMultiGroupDataInComponent(), and findInstanceOfTypeInLineage().

◆ findInstanceOfTypeInLineage() [2/2]

Form * GIDI::Suite::findInstanceOfTypeInLineage	(	Styles::Suite const &	a_styles,
		std::string const &	a_label,
		std::string const &	a_moniker )

This method finds the nearest form of instance Functions::XYs1d in this that is prior to the form with label a_label.

Parameters

a_styles	[in] The styles suite for the protare.
a_label	[in] The label of the form to start from when looking backwards.
a_formType	[in] The type of form to return.

Returns: Pointer to an Functions::XYs1d instance of nullptr if one not found.

Definition at line 351 of file GIDI_suite.cc.

                                                                                                                            {
 
    auto stylesIter = a_styles.find( a_label );
    if( stylesIter != a_styles.end( ) ) {
        auto suiteIter = find( a_label );
        if( suiteIter != end( ) ) {
            if( (*suiteIter)->actualMoniker( ) == a_moniker ) return( *checkLazyParsingHelperFormIterator( suiteIter ) );
        }
        Styles::Base const *style = static_cast<Styles::Base const *>( *stylesIter );
        return( findInstanceOfTypeInLineage( a_styles, style->getDerivedStyle( )->keyValue( ), a_moniker ) );
    }
 
    return( nullptr );
}

◆ get() [1/8]

template<typename T>

T * GIDI::Suite::get ( std::size_t a_index )

Returns the node at index a_index.

Parameters

a_index [in] The index of the node to return.

Returns: The node at index a_index.

Definition at line 2642 of file GIDI.hpp.

                                                      {
 
    Form *__form = checkLazyParsingHelperForm( a_index );
    T *object = dynamic_cast<T *>( __form );
 
    if( object == nullptr ) throw Exception( "GIDI::Suite::get( std::size_t ): invalid cast" );
 
    return( object );
}

Referenced by GIDI::calculate1dMultiGroupDataInComponent(), GIDI::Product::continuousEnergyProductData(), findInAncestry3(), findInAncestry3(), GIDI::Styles::Suite::findLabelInLineage(), get(), getViaLineage(), getViaLineage(), MCGIDI::HeatedCrossSectionContinuousEnergy::HeatedCrossSectionContinuousEnergy(), GIDI::Product::mapContinuousEnergyProductData(), GIDI::Reaction::modifyCrossSection(), MCGIDI::OutputChannel::OutputChannel(), MCGIDI::Distributions::parseGIDI(), MCGIDI::Functions::parseMultiplicityFunction1d(), GIDI::Transporting::Particles::process(), GIDI::Reaction::recalculateMultiGroupData(), and GIDI::ExternalFiles::Suite::registerBinaryFiles().

◆ get() [2/8]

template<typename T>

T const * GIDI::Suite::get ( std::size_t a_Index ) const

◆ get() [3/8]

template<typename T>

T const * GIDI::Suite::get ( std::size_t a_index ) const

Returns the node at index a_index.

Parameters

a_index [in] The index of the node to return.

Returns: The node at index a_index.

Definition at line 2660 of file GIDI.hpp.

                                                                  {
 
    Form *__form = checkLazyParsingHelperForm( a_index );
    T *object = dynamic_cast<T *>( __form );
 
    if( object == nullptr ) throw Exception( "GIDI::Suite::get( std::size_t ): invalid cast" );
 
    return( object );
}

◆ get() [4/8]

template<typename T>

T const * GIDI::Suite::get ( std::size_t a_index ) const

Returns the node at index a_index.

Parameters

a_index [in] The index of the node to return.

Returns: The node at index a_index.

Definition at line 319 of file GUPI.hpp.

                                                                  {
 
    Entry *entry = m_entries[a_index];
    T *object = dynamic_cast<T *>( entry );
 
    if( object == nullptr ) throw LUPI::Exception( "GIDI::Suite::get( std::size_t ): invalid cast" );
 
    return( object );
}

◆ get() [5/8]

template<typename T>

T * GIDI::Suite::get ( std::string const & a_label )

Returns the node with label a_label.

Parameters

a_label [in] The label of the node to return.

Returns: The node with label a_label.

Definition at line 2678 of file GIDI.hpp.

                                                             {
 
    auto index = (*this)[a_label];
    Form *__form = checkLazyParsingHelperForm( index );
    T *object = dynamic_cast<T *>( __form );
 
    if( object == nullptr ) throw Exception( "GIDI::Suite::get( std::string const & ): invalid cast" );
 
    return( object );
}

◆ get() [6/8]

template<typename T>

T const * GIDI::Suite::get ( std::string const & a_label ) const

Returns the node with label a_label.

Parameters

a_label [in] The label of the node to return.

Returns: The node with label a_label.

Definition at line 2697 of file GIDI.hpp.

                                                                         {
 
    auto index = (*this)[a_label];
    Form *__form = checkLazyParsingHelperForm( index );
    T *object = dynamic_cast<T *>( __form );
 
    if( object == nullptr ) throw Exception( "GIDI::Suite::get( std::string const & ): invalid cast" );
 
    return( object );
}

◆ get() [7/8]

template<typename T>

T const * GIDI::Suite::get ( std::string const & a_label ) const

◆ get() [8/8]

template<typename T>

T const * GIDI::Suite::get ( std::string const & a_label ) const

Returns the node with label a_label.

Parameters

a_label [in] The label of the node to return.

Returns: The node with label a_label.

Definition at line 356 of file GUPI.hpp.

                                                                         {
 
    auto index = (*this)[a_label];
    Entry *entry = m_entries[index];
    T *object = dynamic_cast<T *>( entry );
 
    if( object == nullptr ) throw LUPI::Exception( "GIDI::Suite::get( std::string const & ): invalid cast" );
 
    return( object );
}

◆ getViaLineage() [1/2]

template<typename T>

T * GIDI::Suite::getViaLineage ( std::string const & a_label )

Definition at line 3447 of file GIDI.hpp.

                                                                       {
 
    std::string const *label = m_styles->findLabelInLineage( (Styles::Suite &) *this, a_label );
 
    return( get<T>( *label ) );
}

Referenced by get(), and MCGIDI::Functions::parseMultiplicityFunction1d().

◆ getViaLineage() [2/2]

template<typename T>

T * GIDI::Suite::getViaLineage ( std::string const & a_label ) const

Definition at line 3457 of file GIDI.hpp.

                                                                             {
 
    std::string const *label = m_styles->findLabelInLineage( (Styles::Suite &) *this, a_label );
 
    return( get<T>( *label ) );
}

◆ has()

bool GIDI::Suite::has ( std::string const & a_label ) const

inline

Definition at line 2616 of file GIDI.hpp.

2616{ return( find( a_label ) != m_forms.end( ) ); }

Referenced by MCGIDI::HeatedCrossSectionContinuousEnergy::HeatedCrossSectionContinuousEnergy(), MCGIDI::Functions::parseMultiplicityFunction1d(), and GIDI::ExternalFiles::Suite::registerBinaryFiles().

◆ href()

std::string const & GIDI::Suite::href ( ) const

inline

Returns a reference to the m_ref member.

Definition at line 2609 of file GIDI.hpp.

◆ keyName()

std::string const & GIDI::Suite::keyName ( ) const

inline

Returns a const reference to the m_keyName member.

Definition at line 2590 of file GIDI.hpp.

◆ modifiedMultiGroupElasticForTNSL()

void GIDI::Suite::modifiedMultiGroupElasticForTNSL ( std::map< std::string, std::size_t > const & a_maximumTNSL_MultiGroupIndex )

Only for internal use. Called by ProtareTNSL instance to zero the lower energy multi-group data covered by the ProtareSingle that contains the TNSL data covers the lower energy multi-group data.

Parameters

a_maximumTNSL_MultiGroupIndex [in] A map that contains labels for heated multi-group data and the last valid group boundary for the TNSL data for that boundary.

Definition at line 374 of file GIDI_suite.cc.

                                                                                                               {
 
    for( auto iter = a_maximumTNSL_MultiGroupIndex.begin( ); iter != a_maximumTNSL_MultiGroupIndex.end( ); ++iter ) {
        auto formIter = find( iter->first, true );
 
        if( formIter == m_forms.end( ) ) continue;
 
        if( (*formIter)->type( ) == FormType::gridded1d ) {
            reinterpret_cast<Functions::Gridded1d *>( (*formIter) )->modifiedMultiGroupElasticForTNSL( iter->second ); }
        else if( (*formIter)->type( ) == FormType::gridded3d ) {
            reinterpret_cast<Functions::Gridded3d *>( (*formIter) )->modifiedMultiGroupElasticForTNSL( iter->second );
        }
    }
}

Referenced by modifiedMultiGroupElasticForTNSL().

◆ operator[]()

std::size_t GIDI::Suite::operator[] ( std::string const & a_keyValue ) const

Returns the index of the node in this that has keyValue a_keyValue.

Returns: [in] The index of the node with keyValue a_keyValue in this.

Definition at line 116 of file GIDI_suite.cc.

                                                               {
 
    auto iter = m_map.find( a_keyValue );
    if( iter == m_map.end( ) ) {
        throw Exception( "form '" + a_keyValue + "' not in suite " + toXLink( ) + "." );
    }
 
    return( iter->second );
}

◆ parse()

void GIDI::Suite::parse	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		PoPI::Database const &	a_pops,
		PoPI::Database const &	a_internalPoPs,
		parseSuite	a_parseSuite,
		Styles::Suite const *	a_styles )

This methods parses all the child nodes of a_node.

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 Product.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_pops	[in] The external PoPI::Database instance used to get particle indices and possibly other particle information.
a_internalPoPs	[in] The internal PoPI::Database instance used to get particle indices and possibly other particle information. This is the <PoPs> node under the <reactionSuite> node.
a_parseSuite	[in] This function to call to parse each sub-node.
a_styles	[in] The <styles> node under the <reactionSuite> node.

Definition at line 93 of file GIDI_suite.cc.

                                                                                                       {
 
    for( HAPI::Node child = a_node.first_child( ); !child.empty( ); child.to_next_sibling( ) ) {
        std::string name( child.name( ) );
 
        Form *form = nullptr;
 
        if( m_allowsLazyParsing && a_construction.lazyParsing( ) ) {
            form = new LazyParsingHelperForm( a_construction, this, child, a_setupInfo, a_pops, a_internalPoPs, name, a_styles, a_parseSuite ); }
        else {
            form = a_parseSuite( a_construction, this, child, a_setupInfo, a_pops, a_internalPoPs, name, a_styles );
        }
        if( form != nullptr ) add( form );
    }
}

Referenced by Suite().

◆ pop() [1/2]

template<typename T>

T * GIDI::Suite::pop ( std::size_t a_index )

Removes the form at index a_index and returns it. It is up to the calling function to delete the form, otherwise there will be memory leak.

Parameters

a_index [in] The index of the node to return.

Returns: The node at index a_index.

Definition at line 2717 of file GIDI.hpp.

                                                      {
 
    Form *__form = checkLazyParsingHelperForm( a_index );
    T *object = dynamic_cast<T *>( __form );
 
    if( object == nullptr ) throw Exception( "GIDI::Suite::pop( std::size_t ): invalid cast" );
 
    for( std::size_t index = a_index + 1; index < m_forms.size( ); ++index ) {
        m_forms[index-1] = m_forms[index];
        m_map[m_forms[index-1]->label( )] = index - 1;
    }
    m_forms.resize( m_forms.size( ) - 1 );
 
    return( object );
}

Referenced by get().

◆ pop() [2/2]

template<typename T>

T * GIDI::Suite::pop ( std::string const & a_label )

Removes the form with label a_label and returns it. It is up to the calling function to delete the form, otherwise there will be memory leak.

Parameters

a_label [in] The label of the node to return.

Returns: The node at index a_label.

Definition at line 2742 of file GIDI.hpp.

                                                             {
 
    auto index = (*this)[a_label];                           // This will throw an exception if *a_label* is not in *this*.
    Form *__form = checkLazyParsingHelperForm( index );
    T *object = dynamic_cast<T *>( __form );
 
    if( object == nullptr ) throw Exception( "GIDI::Suite::pop( std::size_t ): invalid cast" );
 
    for( std::size_t index2 = index + 1; index2 < m_forms.size( ); ++index2 ) {
        m_forms[index2-1] = m_forms[index2];
        m_map[m_forms[index2-1]->label( )] = index2 - 1;
    }
    m_forms.resize( m_forms.size( ) - 1 );
 
    return( object );
 
}

◆ printFormLabels()

void GIDI::Suite::printFormLabels ( std::string const & a_header ) const

Prints the list of node keyValues to std::cout.

Parameters

a_header [in] A string printed before the list of keyValues is printed.

Definition at line 462 of file GIDI_suite.cc.

                                                             {
 
    std::cout << a_header << ": size = " << size( ) << std::endl;
    
    for( Suite::const_iterator iter = m_forms.begin( ); iter != m_forms.end( ); ++iter ) 
            std::cout << "    " << (*iter)->keyValue( ) << std::endl;
}

◆ size()

std::size_t GIDI::Suite::size ( ) const

inline

Returns the number of node contained by this.

Definition at line 2591 of file GIDI.hpp.

Referenced by MCGIDI::GRIN_capture::GRIN_capture(), MCGIDI::GRIN_inelastic::GRIN_inelastic(), MCGIDI::OutputChannel::OutputChannel(), MCGIDI::Distributions::parseGIDI(), printFormLabels(), and toXMLList().

◆ styles()

Styles::Suite const * GIDI::Suite::styles ( )

inline

Returns the value of the m_styles member.

Definition at line 2608 of file GIDI.hpp.

Referenced by GIDI::Reaction::modifyCrossSection().

◆ toXMLList()

void GIDI::Suite::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 442 of file GIDI_suite.cc.

                                                                                   {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
 
    if( size( ) == 0 ) return;
 
    std::string XMLLine( a_indent + "<" + moniker( ) + ">" );
    a_writeInfo.push_back( XMLLine );
 
    for( Suite::const_iterator iter = m_forms.begin( ); iter != m_forms.end( ); ++iter ) (*iter)->toXMLList( a_writeInfo, indent2 );
 
    a_writeInfo.addNodeEnder( moniker( ) );
}

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ Forms

◆ iterator

Constructor & Destructor Documentation

◆ Suite() [1/3]

◆ Suite() [2/3]

◆ Suite() [3/3]

◆ ~Suite()

Member Function Documentation

◆ add()

◆ begin() [1/2]

◆ begin() [2/2]

◆ checkLazyParsingHelperForm() [1/2]

◆ checkLazyParsingHelperForm() [2/2]

◆ checkLazyParsingHelperFormIterator() [1/2]

◆ checkLazyParsingHelperFormIterator() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ find() [1/2]

◆ find() [2/2]

◆ findAllOfMoniker() [1/2]

◆ findAllOfMoniker() [2/2]

◆ findInAncestry3() [1/2]

◆ findInAncestry3() [2/2]

◆ findInstanceOfTypeInLineage() [1/2]

◆ findInstanceOfTypeInLineage() [2/2]

◆ get() [1/8]

◆ get() [2/8]

◆ get() [3/8]

◆ get() [4/8]

◆ get() [5/8]

◆ get() [6/8]

◆ get() [7/8]

◆ get() [8/8]

◆ getViaLineage() [1/2]

◆ getViaLineage() [2/2]

◆ has()

◆ href()

◆ keyName()

◆ modifiedMultiGroupElasticForTNSL()

◆ operator[]()

◆ parse()

◆ pop() [1/2]

◆ pop() [2/2]

◆ printFormLabels()

◆ size()

◆ styles()

◆ toXMLList()