SST  7.1.0
StructuralSimulationToolkit
SST::SSTInfoElement_ComponentInfo Class Reference

The SSTInfo representation of ElementInfoComponent object. More...

#include <sstinfo.h>

Inheritance diagram for SST::SSTInfoElement_ComponentInfo:
SST::SSTInfoElement_BaseInfo SST::SSTInfoElement_Outputter

Public Member Functions

 SSTInfoElement_ComponentInfo (const ElementInfoComponent *elc)
 Create a new SSTInfoElement_ComponentInfo object. More...
 
 SSTInfoElement_ComponentInfo (ComponentElementInfo *elc)
 
SSTInfoElement_ParamInfogetParamInfo (int index)
 Return a Parameter Info Object. More...
 
SSTInfoElement_PortInfogetPortInfo (int index)
 Return a Port Info Object. More...
 
SSTInfoElement_StatisticInfogetStatisticInfo (int index)
 Return a Statistic Enable Info Object. More...
 
uint32_t getCategoryValue ()
 Return the Category value of the Component. More...
 
std::string getCategoryString () const
 Return the name of the Category of the Component. More...
 
void outputHumanReadable (int index) override
 Output the Component Information. More...
 
void outputXML (int Index, TiXmlNode *XMLParentElement) override
 Create the formatted XML data of the Component. More...
 
- Public Member Functions inherited from SST::SSTInfoElement_BaseInfo
template<typename T >
 SSTInfoElement_BaseInfo (const T *eli)
 
 SSTInfoElement_BaseInfo (BaseElementInfo &eli)
 
 SSTInfoElement_BaseInfo (PartitionerElementInfo &eli)
 
const std::string & getName ()
 Return the Name of the Element. More...
 
const std::string & getDesc ()
 Return the Description of the Parameter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SST::SSTInfoElement_BaseInfo
template<typename TO , typename FROM >
std::vector< TO > convertFromELI (const FROM *ptr)
 
template<typename TO , typename FROM >
std::vector< TO > convertFromDB (const std::vector< FROM > &input)
 
std::string fs (const char *x)
 
- Protected Member Functions inherited from SST::SSTInfoElement_Outputter
void xmlComment (TiXmlNode *owner, const char *fmt...)
 
- Protected Attributes inherited from SST::SSTInfoElement_BaseInfo
std::string m_name
 
std::string m_desc
 

Detailed Description

The SSTInfo representation of ElementInfoComponent object.

This class is used internally by SSTInfo to load and process ElementInfoComponent objects.

Constructor & Destructor Documentation

◆ SSTInfoElement_ComponentInfo()

SST::SSTInfoElement_ComponentInfo::SSTInfoElement_ComponentInfo ( const ElementInfoComponent elc)
inline

Member Function Documentation

◆ getCategoryString()

std::string SSTInfoElement_ComponentInfo::getCategoryString ( ) const

Return the name of the Category of the Component.

◆ getCategoryValue()

uint32_t SST::SSTInfoElement_ComponentInfo::getCategoryValue ( )
inline

Return the Category value of the Component.

◆ getParamInfo()

SSTInfoElement_ParamInfo* SST::SSTInfoElement_ComponentInfo::getParamInfo ( int  index)
inline

Return a Parameter Info Object.

Parameters
indexThe index of the Parameter.

◆ getPortInfo()

SSTInfoElement_PortInfo* SST::SSTInfoElement_ComponentInfo::getPortInfo ( int  index)
inline

Return a Port Info Object.

Parameters
indexThe index of the Port.

◆ getStatisticInfo()

SSTInfoElement_StatisticInfo* SST::SSTInfoElement_ComponentInfo::getStatisticInfo ( int  index)
inline

Return a Statistic Enable Info Object.

Parameters
indexThe index of the Statistic Enable.

◆ outputHumanReadable()

void SSTInfoElement_ComponentInfo::outputHumanReadable ( int  index)
overridevirtual

Output the Component Information.

Parameters
IndexThe Index of the Component.

Implements SST::SSTInfoElement_Outputter.

Referenced by SST::SSTInfoElement_LibraryInfo::outputHumanReadable().

◆ outputXML()

void SSTInfoElement_ComponentInfo::outputXML ( int  Index,
TiXmlNode *  XMLParentElement 
)
overridevirtual

Create the formatted XML data of the Component.

Parameters
IndexThe Index of the Component.
XMLParentElementThe parent element to receive the XML data.

Implements SST::SSTInfoElement_Outputter.

Referenced by SST::SSTInfoElement_LibraryInfo::outputXML().


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