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.
const char *	getName ()
	Return the Name of the Port.
const char *	getDesc ()
	Return the Description of the Port.
const char **	getValidEvents ()
	Return the array of Valid Events related to the Port.
int	getNumberOfValidEvents ()
	Return the number of Valid Events related to the Port.
const char *	getValidEvent (unsigned int index)
	Return the a specific Valid Events.
void	outputPortInfo (int Index)
	Output the Port Information.
void	generatePortInfoXMLData (int Index, TiXmlNode *XMLParentElement)
	Create the formatted XML data of the Port.

---

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:

elport

Pointer to an ElementInfoPort object.

---

Member Function Documentation

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

Create the formatted XML data of the Port.

Parameters:

	Index	The Index of the Port.
	XMLParentElement	The parent element to receive the XML data.

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

Referenced by SST::SSTInfoElement_ComponentInfo::generateComponentInfoXMLData().

const char* SST::SSTInfoElement_PortInfo::getDesc

(

)

[inline]

Return the Description of the Port.

References SST::ElementInfoPort::description.

Referenced by generatePortInfoXMLData(), and outputPortInfo().

const char* SST::SSTInfoElement_PortInfo::getName

(

)

[inline]

Return the Name of the Port.

References SST::ElementInfoPort::name.

Referenced by generatePortInfoXMLData(), and outputPortInfo().

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:

index

The index of the Valid Event.

References SST::ElementInfoPort::validEvents.

Referenced by generatePortInfoXMLData(), and outputPortInfo().

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:

Index

The Index of the Port.

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

Referenced by SST::SSTInfoElement_ComponentInfo::outputComponentInfo().

---

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

• sst/core/sstinfo.h
• sst/core/sstinfo.cc