SST 16.0.0
Structural Simulation Toolkit
SST::SSTInfoConfig Class Reference

The SSTInfo Configuration class. More...

#include <sstinfo.h>

Inheritance diagram for SST::SSTInfoConfig:
SST::ConfigShared SST::ConfigBase

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 ()
bool processAllElements () const
bool doVerbose () 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.
std::string getLibPath (bool exclude_ext_paths=false) 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)
Protected Member Functions inherited from SST::ConfigBase
 ConfigBase ()
 Default constructor used for serialization.
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 addAnnotation (const AnnotationInfo &info)
 Add an annotation available to the options.
void addOption (struct option opt, const char *argname, const char *desc, std::vector< bool > annotations, OptionDefinition *def)
 Add options to the Config object.
void addHeading (const char *desc)
 Adds a heading to the usage output.
virtual int checkArgsAfterParsing ()
 Function that will be called at the end of parsing so that error checking can be done.
void enableDashDashSupport (std::function< int(const char *arg)> callback)
 Enable support for everything after – to be passed to a callback.
void addPositionalCallback (std::function< int(int num, const char *arg)> callback)
 Add support for positional args.
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.
size_t getAnnotationIndex (char annotation)
 Get the index in the annotation vector for the given annotation.
void enable_printing ()

Additional Inherited Members

Static Public Member Functions inherited from SST::ConfigBase
static uint32_t parseWallTimeToSeconds (const std::string &arg, bool &success, const std::string &option)
 Function to parse a string to wall time using one of the following formats:
Static Public Attributes inherited from SST::ConfigBase
static std::string currently_parsing_option = ""
 Variable used to identify the currently parsing option.
Protected Attributes inherited from SST::ConfigBase
std::vector< LongOptionoptions

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

◆ 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().

◆ 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