SST  7.2.0
StructuralSimulationToolkit
SST::SSTInfoElement_PortInfo Class Reference

The SSTInfo representation of ElementInfoPort object. More...

#include <sstinfo.h>

Inheritance diagram for SST::SSTInfoElement_PortInfo:
SST::SSTInfoElement_BaseInfo SST::SSTInfoElement_Outputter

Public Member Functions

 SSTInfoElement_PortInfo (const ElementInfoPort *elport)
 Create a new SSTInfoElement_PortInfo object. More...
 
 SSTInfoElement_PortInfo (const ElementInfoPort2 *elport)
 
const std::vector< std::string > & 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 std::string & getValidEvent (unsigned int index)
 Return the a specific Valid Events. More...
 
void outputHumanReadable (int index) override
 Output the Port Information. More...
 
void outputXML (int Index, TiXmlNode *XMLParentElement) override
 Create the formatted XML data of the Port. More...
 
- Public Member Functions inherited from SST::SSTInfoElement_BaseInfo
template<typename T >
 SSTInfoElement_BaseInfo (const T *eli)
 
 SSTInfoElement_BaseInfo (BaseElementInfo &eli)
 
 SSTInfoElement_BaseInfo (PartitionerElementInfo &eli)
 
const std::string & getName ()
 Return the Name of the Element. More...
 
const std::string & getDesc ()
 Return the Description of the Parameter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SST::SSTInfoElement_BaseInfo
template<typename TO , typename FROM >
std::vector< TO > convertFromELI (const FROM *ptr)
 
template<typename TO , typename FROM >
std::vector< TO > convertFromDB (const std::vector< FROM > &input)
 
std::string fs (const char *x)
 
- Protected Member Functions inherited from SST::SSTInfoElement_Outputter
void xmlComment (TiXmlNode *owner, const char *fmt...)
 
- Protected Attributes inherited from SST::SSTInfoElement_BaseInfo
std::string m_name
 
std::string m_desc
 

Detailed Description

The SSTInfo representation of ElementInfoPort object.

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

Constructor & Destructor Documentation

◆ SSTInfoElement_PortInfo()

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

Create a new SSTInfoElement_PortInfo object.

Parameters
elportPointer to an ElementInfoPort object.

References SST::ElementInfoPort::validEvents, and SST::ElementInfoPort2::validEvents.

Member Function Documentation

◆ getNumberOfValidEvents()

int SST::SSTInfoElement_PortInfo::getNumberOfValidEvents ( )
inline

Return the number of Valid Events related to the Port.

◆ getValidEvent()

const std::string& SST::SSTInfoElement_PortInfo::getValidEvent ( unsigned int  index)
inline

Return the a specific Valid Events.

Parameters
indexThe index of the Valid Event.

◆ getValidEvents()

const std::vector<std::string>& SST::SSTInfoElement_PortInfo::getValidEvents ( )
inline

Return the array of Valid Events related to the Port.

◆ outputHumanReadable()

void SSTInfoElement_PortInfo::outputHumanReadable ( int  index)
overridevirtual

Output the Port Information.

Parameters
IndexThe Index of the Port.

Implements SST::SSTInfoElement_Outputter.

◆ outputXML()

void SSTInfoElement_PortInfo::outputXML ( int  Index,
TiXmlNode *  XMLParentElement 
)
overridevirtual

Create the formatted XML data of the Port.

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

Implements SST::SSTInfoElement_Outputter.


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