SST  7.0.0
StructuralSimulationToolkit
SST::SSTInfoElement_LibraryInfo Class Reference

The SSTInfo representation of ElementLibraryInfo object. More...

#include <sstinfo.h>

Inheritance diagram for SST::SSTInfoElement_LibraryInfo:
SST::SSTInfoElement_Outputter

Public Member Functions

 SSTInfoElement_LibraryInfo (const ElementLibraryInfo *eli)
 Create a new SSTInfoElement_LibraryInfo object. More...
 
std::string getLibraryName ()
 Return the Name of the Library. More...
 
std::string getLibraryDescription ()
 Return the Description of the Library. More...
 
int getNumberOfLibraryComponents ()
 Return the number of Components within the Library. More...
 
int getNumberOfLibraryEvents ()
 Return the number of Events within the Library. More...
 
int getNumberOfLibraryModules ()
 Return the number of Modules within the Library. More...
 
int getNumberOfLibrarySubComponents ()
 Return the number of SubComponents within the Library. More...
 
int getNumberOfLibraryPartitioners ()
 Return the number of Partitioners within the Library. More...
 
int getNumberOfLibraryGenerators ()
 Return the number of Generators within the Library. More...
 
const ElementLibraryInfogetLibraryInfo ()
 Return the ElementLibraryInfo object. More...
 
SSTInfoElement_ComponentInfogetInfoComponent (int Index)
 Return a specific SSTInfoElement_ComponentInfo object. More...
 
SSTInfoElement_EventInfogetInfoEvent (int Index)
 Return a specific SSTInfoElement_EventInfo object. More...
 
SSTInfoElement_ModuleInfogetInfoModule (int Index)
 Return a specific SSTInfoElement_ModuleInfo object. More...
 
SSTInfoElement_SubComponentInfogetInfoSubComponent (int Index)
 Return a specific SSTInfoElement_SubComponentInfo object. More...
 
SSTInfoElement_PartitionerInfogetInfoPartitioner (int Index)
 Return a specific SSTInfoElement_PartitionerInfo object. More...
 
SSTInfoElement_GeneratorInfogetInfoGenerator (int Index)
 Return a specific SSTInfoElement_GeneratorInfo object. More...
 
void outputHumanReadable (int LibIndex) override
 Output the Library Information. More...
 
void outputXML (int LibIndex, TiXmlNode *XMLParentElement) override
 Create the formatted XML data of the Library. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SST::SSTInfoElement_Outputter
void xmlComment (TiXmlNode *owner, const char *fmt...)
 

Detailed Description

The SSTInfo representation of ElementLibraryInfo object.

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

Constructor & Destructor Documentation

SST::SSTInfoElement_LibraryInfo::SSTInfoElement_LibraryInfo ( const ElementLibraryInfo eli)
inline

Create a new SSTInfoElement_LibraryInfo object.

Parameters
eliPointer to an ElementLibraryInfo object.

Member Function Documentation

SSTInfoElement_ComponentInfo* SST::SSTInfoElement_LibraryInfo::getInfoComponent ( int  Index)
inline

Return a specific SSTInfoElement_ComponentInfo object.

Parameters
IndexThe index of the object.
SSTInfoElement_EventInfo* SST::SSTInfoElement_LibraryInfo::getInfoEvent ( int  Index)
inline

Return a specific SSTInfoElement_EventInfo object.

Parameters
IndexThe index of the object.
SSTInfoElement_GeneratorInfo* SST::SSTInfoElement_LibraryInfo::getInfoGenerator ( int  Index)
inline

Return a specific SSTInfoElement_GeneratorInfo object.

Parameters
IndexThe index of the object.
SSTInfoElement_ModuleInfo* SST::SSTInfoElement_LibraryInfo::getInfoModule ( int  Index)
inline

Return a specific SSTInfoElement_ModuleInfo object.

Parameters
IndexThe index of the object.
SSTInfoElement_PartitionerInfo* SST::SSTInfoElement_LibraryInfo::getInfoPartitioner ( int  Index)
inline

Return a specific SSTInfoElement_PartitionerInfo object.

Parameters
IndexThe index of the object.
SSTInfoElement_SubComponentInfo* SST::SSTInfoElement_LibraryInfo::getInfoSubComponent ( int  Index)
inline

Return a specific SSTInfoElement_SubComponentInfo object.

Parameters
IndexThe index of the object.
std::string SST::SSTInfoElement_LibraryInfo::getLibraryDescription ( )
inline

Return the Description of the Library.

References SST::ElementLibraryInfo::description.

const ElementLibraryInfo* SST::SSTInfoElement_LibraryInfo::getLibraryInfo ( )
inline

Return the ElementLibraryInfo object.

std::string SST::SSTInfoElement_LibraryInfo::getLibraryName ( )
inline

Return the Name of the Library.

References SST::ElementLibraryInfo::name.

int SST::SSTInfoElement_LibraryInfo::getNumberOfLibraryComponents ( )
inline

Return the number of Components within the Library.

int SST::SSTInfoElement_LibraryInfo::getNumberOfLibraryEvents ( )
inline

Return the number of Events within the Library.

int SST::SSTInfoElement_LibraryInfo::getNumberOfLibraryGenerators ( )
inline

Return the number of Generators within the Library.

int SST::SSTInfoElement_LibraryInfo::getNumberOfLibraryModules ( )
inline

Return the number of Modules within the Library.

int SST::SSTInfoElement_LibraryInfo::getNumberOfLibraryPartitioners ( )
inline

Return the number of Partitioners within the Library.

int SST::SSTInfoElement_LibraryInfo::getNumberOfLibrarySubComponents ( )
inline

Return the number of SubComponents within the Library.

void SSTInfoElement_LibraryInfo::outputXML ( int  LibIndex,
TiXmlNode *  XMLParentElement 
)
overridevirtual

Create the formatted XML data of the Library.

Parameters
LibIndexThe Index of the Library.
XMLParentElementThe parent element to receive the XML data.

Implements SST::SSTInfoElement_Outputter.

References SST::SSTInfoElement_ComponentInfo::outputXML(), SST::SSTInfoElement_EventInfo::outputXML(), SST::SSTInfoElement_ModuleInfo::outputXML(), SST::SSTInfoElement_PartitionerInfo::outputXML(), and SST::SSTInfoElement_GeneratorInfo::outputXML().


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