SST  6.0.0
StructuralSimulationToolkit
SST::SSTInfoElement_PortInfo Class Reference

The SSTInfo representation of ElementInfoPort object. More...

#include <sstinfo.h>

Public Member Functions

 SSTInfoElement_PortInfo (const ElementInfoPort *elport)
 Create a new SSTInfoElement_PortInfo object. More...
 
const char * getName ()
 Return the Name of the Port. More...
 
const char * getDesc ()
 Return the Description of the Port. More...
 
const char ** getValidEvents ()
 Return the array of Valid Events related to the Port. More...
 
int getNumberOfValidEvents ()
 Return the number of Valid Events related to the Port. More...
 
const char * getValidEvent (unsigned int index)
 Return the a specific Valid Events. More...
 
void outputPortInfo (int Index)
 Output the Port Information. More...
 
void generatePortInfoXMLData (int Index, TiXmlNode *XMLParentElement)
 Create the formatted XML data of the Port. More...
 

Detailed Description

The SSTInfo representation of ElementInfoPort object.

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

Constructor & Destructor Documentation

SST::SSTInfoElement_PortInfo::SSTInfoElement_PortInfo ( const ElementInfoPort elport)
inline

Create a new SSTInfoElement_PortInfo object.

Parameters
elportPointer to an ElementInfoPort object.

Member Function Documentation

void SSTInfoElement_PortInfo::generatePortInfoXMLData ( int  Index,
TiXmlNode *  XMLParentElement 
)

Create the formatted XML data of the Port.

Parameters
IndexThe Index of the Port.
XMLParentElementThe parent element to receive the XML data.
const char* SST::SSTInfoElement_PortInfo::getDesc ( )
inline

Return the Description of the Port.

References SST::ElementInfoPort::description.

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

Return the Name of the Port.

References SST::ElementInfoPort::name.

int SST::SSTInfoElement_PortInfo::getNumberOfValidEvents ( )
inline

Return the number of Valid Events related to the Port.

const char * SSTInfoElement_PortInfo::getValidEvent ( unsigned int  index)

Return the a specific Valid Events.

Parameters
indexThe index of the Valid Event.
const char** SST::SSTInfoElement_PortInfo::getValidEvents ( )
inline

Return the array of Valid Events related to the Port.

References SST::ElementInfoPort::validEvents.

void SSTInfoElement_PortInfo::outputPortInfo ( int  Index)

Output the Port Information.

Parameters
IndexThe Index of the Port.

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