SST  6.0.0
StructuralSimulationToolkit
SST::SSTInfoElement_ParamInfo Class Reference

The SSTInfo representation of ElementInfoParam object. More...

#include <sstinfo.h>

Public Member Functions

 SSTInfoElement_ParamInfo (const ElementInfoParam *elparam)
 Create a new SSTInfoElement_ParamInfo object. More...
 
const char * getName ()
 Return the Name of the Parameter. More...
 
const char * getDesc ()
 Return the Description of the Parameter. More...
 
const char * getDefault ()
 Return the Default value of the Parameter. More...
 
void outputParameterInfo (int Index)
 Output the Parameter Information. More...
 
void generateParameterInfoXMLData (int Index, TiXmlNode *XMLParentElement)
 Create the formatted XML data of the Parameter. More...
 

Detailed Description

The SSTInfo representation of ElementInfoParam object.

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

Constructor & Destructor Documentation

SST::SSTInfoElement_ParamInfo::SSTInfoElement_ParamInfo ( const ElementInfoParam elparam)
inline

Create a new SSTInfoElement_ParamInfo object.

Parameters
elparamPointer to an ElementInfoParam object.

Member Function Documentation

void SSTInfoElement_ParamInfo::generateParameterInfoXMLData ( int  Index,
TiXmlNode *  XMLParentElement 
)

Create the formatted XML data of the Parameter.

Parameters
IndexThe Index of the Parameter.
XMLParentElementThe parent element to receive the XML data.
const char* SST::SSTInfoElement_ParamInfo::getDefault ( )
inline

Return the Default value of the Parameter.

References SST::ElementInfoParam::defaultValue.

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

Return the Description of the Parameter.

References SST::ElementInfoParam::description.

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

Return the Name of the Parameter.

References SST::ElementInfoParam::name.

void SSTInfoElement_ParamInfo::outputParameterInfo ( int  Index)

Output the Parameter Information.

Parameters
IndexThe Index of the Parameter.

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