SST::SSTInfoConfig Class Reference

The SSTInfo Configuration class. More...

#include <sstinfo.h>

Inheritance diagram for SST::SSTInfoConfig:

Public Types
using	FilterMap_t = std::multimap<std::string, std::string>

Public Member Functions
	SSTInfoConfig (bool suppress_print)
	Create a new SSTInfo configuration and parse the Command Line.
std::set< std::string >	getElementsToProcessArray ()
	Return the list of elements to be processed.
void	clearFilterMap ()
	Clears the current filter map.
FilterMap_t &	getFilterMap ()
unsigned int	getOptionBits ()
std::string &	getXMLFilePath ()
bool	debugEnabled () const
bool	processAllElements () const
bool	doVerbose () const
bool	interactiveEnabled () const
void	addFilter (const std::string &name)
Public Member Functions inherited from SST::ConfigShared
	ConfigShared (bool suppress_print, bool include_libpath, bool include_env, bool include_verbose)
	ConfigShared constructor that it meant to be used when needing a stand alone ConfigShared (i.e.
bool	print_env () const
	Controls whether the environment variables that SST sees are printed out.
bool	no_env_config () const
int	verbose () const
std::string	libpath () const
std::string	addLibPath () const
std::string	getLibPath () const
	Get the library path for loading element libraries.
Public Member Functions inherited from SST::ConfigBase
int	parseCmdLine (int argc, char *argv[], bool ignore_unknown=false)
	Parse command-line arguments to update configuration values.
bool	wasOptionSetOnCmdLine (const std::string &option)
	Check to see if an option was set on the command line.

Protected Member Functions
std::string	getUsagePrelude () override
	Called to get the prelude for the help/usage message.
Protected Member Functions inherited from SST::ConfigShared
void	addLibraryPathOptions ()
void	addEnvironmentOptions ()
void	addVerboseOptions (bool sdl_avail)
	ConfigShared (bool suppress_print, std::vector< AnnotationInfo > annotations)
	ConfigShared constructor for child classes.
	ConfigShared ()
	Default constructor used for serialization.
Protected Member Functions inherited from SST::ConfigBase
	ConfigBase (bool suppress_print)
	ConfigBase constructor.
	ConfigBase ()
	Default constructor used for serialization.
	ConfigBase (bool suppress_print, std::vector< AnnotationInfo > annotations)
int	printUsage ()
	Called to print the help/usage message.
int	printExtHelp (const std::string &option)
	Called to print the extended help for an option.
void	addOption (struct option opt, const char *argname, const char *desc, std::function< int(const char *arg)> callback, std::vector< bool > annotations, std::function< std::string()> ext_help=std::function< std::string()>())
	Add options to the Config object.
void	addHeading (const char *desc)
	Adds a heading to the usage output.
virtual int	checkArgsAfterParsing ()
void	enableDashDashSupport (std::function< int(const char *arg)> callback)
void	addPositionalCallback (std::function< int(int num, const char *arg)> callback)
std::string	getRunName ()
	Get the name of the executable being run.
bool	setOptionExternal (const std::string &entryName, const std::string &value)
	Set a configuration string to update configuration values.
bool	getAnnotation (const std::string &entryName, char annotation)
	Get the value of an annotation for an option.

Additional Inherited Members
Static Public Member Functions inherited from SST::ConfigBase
static bool	parseBoolean (const std::string &arg, bool &success, const std::string &option)
static uint32_t	parseWallTimeToSeconds (const std::string &arg, bool &success, const std::string &option)
Protected Attributes inherited from SST::ConfigShared
std::string	libpath_ = ""
std::string	addlibpath_ = ""
bool	print_env_ = false
bool	no_env_config_ = false
int	verbose_ = 0

Detailed Description

The SSTInfo Configuration class.

This class will parse the command line, and setup internal lists of elements and components to be processed.

Member Function Documentation

debugEnabled()

bool SST::SSTInfoConfig::debugEnabled ( ) const

inline

Returns

True if the debugging output is enabled, otherwise False

doVerbose()

bool SST::SSTInfoConfig::doVerbose ( ) const

inline

Returns

True if command line options are enabled and verbose configuration is valid, otherwise False

getFilterMap()

FilterMap_t & SST::SSTInfoConfig::getFilterMap ( )

inline

Returns

Filter map

getOptionBits()

unsigned int SST::SSTInfoConfig::getOptionBits ( )

inline

Returns

Bit field of various command line options enabled.

getUsagePrelude()

std::string SSTInfoConfig::getUsagePrelude ( )

overrideprotectedvirtual

Called to get the prelude for the help/usage message.

Reimplemented from SST::ConfigBase.

References SST::ConfigBase::getRunName().

getXMLFilePath()

std::string & SST::SSTInfoConfig::getXMLFilePath ( )

inline

Returns

User defined path the XML File.

interactiveEnabled()

bool SST::SSTInfoConfig::interactiveEnabled ( ) const

inline

Returns

True if interactive is enabled, otherwise False

processAllElements()

bool SST::SSTInfoConfig::processAllElements ( ) const

inline

Returns

True if the m_filter multimap is emtpy, otherwise False

---

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

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