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.
const char * getName ()
 Return the Name of the Parameter.
const char * getDesc ()
 Return the Description of the Parameter.
const char * getDefault ()
 Return the Default value of the Parameter.
void outputParameterInfo (int Index)
 Output the Parameter Information.
void generateParameterInfoXMLData (int Index, TiXmlNode *XMLParentElement)
 Create the formatted XML data of the Parameter.

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:
elparam Pointer to an ElementInfoParam object.

Member Function Documentation

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

Create the formatted XML data of the Parameter.

Parameters:
Index The Index of the Parameter.
XMLParentElement The parent element to receive the XML data.

References getDefault(), getDesc(), and getName().

Referenced by SST::SSTInfoElement_ComponentInfo::generateComponentInfoXMLData(), SST::SSTInfoElement_IntrospectorInfo::generateIntrospectorInfoXMLData(), SST::SSTInfoElement_ModuleInfo::generateModuleInfoXMLData(), and SST::SSTInfoElement_SubComponentInfo::generateSubComponentInfoXMLData().

const char* SST::SSTInfoElement_ParamInfo::getDefault (  )  [inline]

Return the Default value of the Parameter.

References SST::ElementInfoParam::defaultValue.

Referenced by generateParameterInfoXMLData(), and outputParameterInfo().

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

Return the Description of the Parameter.

References SST::ElementInfoParam::description.

Referenced by generateParameterInfoXMLData(), and outputParameterInfo().

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

Return the Name of the Parameter.

References SST::ElementInfoParam::name.

Referenced by generateParameterInfoXMLData(), and outputParameterInfo().

void SSTInfoElement_ParamInfo::outputParameterInfo ( int  Index  ) 

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

Generated on 14 Sep 2015 for SST by  doxygen 1.6.1