SST::SSTLibraryInfo Class Reference

The SSTInfo representation of ElementLibraryInfo object. More...

#include <sstinfo.h>

Data Structures
struct	ComponentInfo

Public Member Functions
	SSTLibraryInfo (const std::string &name)
	Create a new SSTInfoElement_LibraryInfo object.
std::string	getLibraryName ()
	Return the Name of the Library.
std::map< std::string, std::vector< ComponentInfo > >	getComponentInfo ()
	Return the map of all component info for the Library.
void	setAllLibraryInfo ()
	Store all Library Information.
void	outputHumanReadable (std::ostream &os, int LibIndex)
	Output the Library Information.
void	outputXML (int Index, TiXmlNode *XMLParentElement)
	Create the formatted XML data of the Library.
void	setLibraryInfo (std::string baseName, std::string componentName, std::string info)
	Put text into info map.
void	outputText (std::stringstream &os)
	Return text from info map based on filters.
void	filterSearch (std::stringstream &outputStream, std::string tag, std::string searchTerm)
	Set filters based on search term.
void	clearHighlights ()
	Clear highlight characters from info strings.
bool	getFilter ()
	Filter output from info map.
void	resetFilters (bool libFilter)
	Clears the component filter and sets the internal library filter status.
void	setLibraryFilter (bool filter)
	Sets the internal library filter status.
int	setComponentFilter (std::string component)
	Adds the component filter string to the end of the internal vector of components.
template<class BaseType>
void	setAllLibraryInfo ()
template<class BaseType>
void	outputHumanReadable (std::ostream &os, bool printAll)
template<class BaseType>
void	outputXML (TiXmlElement *node)
std::string	getLibraryDescription ()

Detailed Description

The SSTInfo representation of ElementLibraryInfo object.

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

Constructor & Destructor Documentation

SSTLibraryInfo()

SST::SSTLibraryInfo::SSTLibraryInfo ( const std::string & name )

inlineexplicit

Create a new SSTInfoElement_LibraryInfo object.

Parameters

eli	Pointer to an ElementLibraryInfo object.

Member Function Documentation

getFilter()

bool SST::SSTLibraryInfo::getFilter ( )

inline

Filter output from info map.

Returns

True if the library filter is defined, otherwise False

outputHumanReadable()

void SSTLibraryInfo::outputHumanReadable	(	std::ostream &	os,
		int	LibIndex )

Output the Library Information.

Parameters

LibIndex

The Index of the Library.

References getLibraryName(), and outputHumanReadable().

Referenced by outputHumanReadable().

outputXML()

void SSTLibraryInfo::outputXML	(	int	Index,
		TiXmlNode *	XMLParentElement )

Create the formatted XML data of the Library.

Parameters

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

References getLibraryName(), and outputXML().

Referenced by outputXML().

resetFilters()

void SST::SSTLibraryInfo::resetFilters ( bool libFilter )

inline

Clears the component filter and sets the internal library filter status.

Parameters

libFilter

setComponentFilter()

int SST::SSTLibraryInfo::setComponentFilter ( std::string component )

inline

Adds the component filter string to the end of the internal vector of components.

Parameters

component

setLibraryFilter()

void SST::SSTLibraryInfo::setLibraryFilter ( bool filter )

inline

Sets the internal library filter status.

Parameters

libFilter

---

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

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