SST  6.1.0
StructuralSimulationToolkit
SST::SSTInfoElement_ComponentInfo Class Reference

The SSTInfo representation of ElementInfoComponent object. More...

#include <sstinfo.h>

Public Member Functions

 SSTInfoElement_ComponentInfo (const ElementInfoComponent *elc)
 Create a new SSTInfoElement_ComponentInfo object. More...
 
const char * getName ()
 Return the Name of the Component. More...
 
const char * getDesc ()
 Return the Description of the Component. More...
 
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...
 
const char * getCategoryString ()
 Return the name of the Category of the Component. More...
 
void outputComponentInfo (int Index)
 Output the Component Information. More...
 
void generateComponentInfoXMLData (int Index, TiXmlNode *XMLParentElement)
 Create the formatted XML data of the Component. More...
 

Detailed Description

The SSTInfo representation of ElementInfoComponent object.

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

Constructor & Destructor Documentation

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

Member Function Documentation

void SSTInfoElement_ComponentInfo::generateComponentInfoXMLData ( int  Index,
TiXmlNode *  XMLParentElement 
)

Create the formatted XML data of the Component.

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

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

const char* SST::SSTInfoElement_ComponentInfo::getCategoryString ( )
inline

Return the name of the Category of the Component.

uint32_t SST::SSTInfoElement_ComponentInfo::getCategoryValue ( )
inline

Return the Category value of the Component.

References SST::ElementInfoComponent::category.

const char* SST::SSTInfoElement_ComponentInfo::getDesc ( )
inline

Return the Description of the Component.

References SST::ElementInfoComponent::description.

const char* SST::SSTInfoElement_ComponentInfo::getName ( )
inline
SSTInfoElement_ParamInfo* SST::SSTInfoElement_ComponentInfo::getParamInfo ( int  index)
inline

Return a Parameter Info Object.

Parameters
indexThe index of the Parameter.
SSTInfoElement_PortInfo* SST::SSTInfoElement_ComponentInfo::getPortInfo ( int  index)
inline

Return a Port Info Object.

Parameters
indexThe index of the Port.
SSTInfoElement_StatisticInfo* SST::SSTInfoElement_ComponentInfo::getStatisticInfo ( int  index)
inline

Return a Statistic Enable Info Object.

Parameters
indexThe index of the Statistic Enable.
void SSTInfoElement_ComponentInfo::outputComponentInfo ( int  Index)

Output the Component Information.

Parameters
IndexThe Index of the Component.

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


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