SST  6.1.0
StructuralSimulationToolkit
SST::SSTInfoElement_ModuleInfo Class Reference

The SSTInfo representation of ElementInfoModule object. More...

#include <sstinfo.h>

Public Member Functions

 SSTInfoElement_ModuleInfo (const ElementInfoModule *elm)
 Create a new SSTInfoElement_ModuleInfo object. More...
 
const char * getName ()
 Return the Name of the Module. More...
 
const char * getDesc ()
 Return the Description of the Module. More...
 
const char * getProvides ()
 Return what class the Module provides. More...
 
SSTInfoElement_ParamInfogetParamInfo (int index)
 Return a Parameter Info Object. More...
 
void outputModuleInfo (int Index)
 Output the Module Information. More...
 
void generateModuleInfoXMLData (int Index, TiXmlNode *XMLParentElement)
 Create the formatted XML data of the Module. More...
 

Detailed Description

The SSTInfo representation of ElementInfoModule object.

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

Constructor & Destructor Documentation

SST::SSTInfoElement_ModuleInfo::SSTInfoElement_ModuleInfo ( const ElementInfoModule elm)
inline

Create a new SSTInfoElement_ModuleInfo object.

Parameters
elmPointer to an ElementInfoModule object.

References SST::ElementInfoModule::params.

Member Function Documentation

void SSTInfoElement_ModuleInfo::generateModuleInfoXMLData ( int  Index,
TiXmlNode *  XMLParentElement 
)

Create the formatted XML data of the Module.

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

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

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

Return the Description of the Module.

References SST::ElementInfoModule::description.

const char* SST::SSTInfoElement_ModuleInfo::getName ( )
inline

Return the Name of the Module.

References SST::ElementInfoModule::name.

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

Return a Parameter Info Object.

Parameters
indexThe index of the Parameter.
const char* SST::SSTInfoElement_ModuleInfo::getProvides ( )
inline

Return what class the Module provides.

References SST::ElementInfoModule::provides.

void SSTInfoElement_ModuleInfo::outputModuleInfo ( int  Index)

Output the Module Information.

Parameters
IndexThe Index of the Module.

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


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