Class to contain SST Simulation Configuration variables. More...
#include <configShared.h>
Public Member Functions | |
| 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. More... | |
| std::string | getLibPath (bool exclude_ext_paths=false) const |
| Get the library path for loading element libraries. More... | |
 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. More... | |
| bool | wasOptionSetOnCmdLine (const std::string &option) |
| Check to see if an option was set on the command line. More... | |
Protected Member Functions | |
| void | addLibraryPathOptions () |
| void | addEnvironmentOptions () |
| void | addVerboseOptions (bool sdl_avail) |
| Protected Member Functions inherited from SST::ConfigBase | |
| ConfigBase () | |
| Default constructor used for serialization. More... | |
| 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. More... | |
| void | addHeading (const char *desc) |
| Adds a heading to the usage output. | |
| virtual std::string | getUsagePrelude () |
| Called to get the prelude for the help/usage message. | |
| 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. More... | |
| void | addPositionalCallback (std::function< int(int num, const char *arg)> callback) |
| Add support for positional args. More... | |
| std::string | getRunName () |
| Get the name of the executable being run. More... | |
| 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: More... | |
| 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< LongOption > | options |
Detailed Description
Class to contain SST Simulation Configuration variables.
NOTE: This class needs to be serialized for the sst.x executable, but not for the sst (wrapper compiled from the boot*.{h,cc} files) executable. To avoid having to compile all the serialization code into the bootstrap executable, the Config class is serialized in serialization/serialize_config.h.
Constructor & Destructor Documentation
◆ ConfigShared()
| 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.
for the bootstrap wrappers for sst and sst-info
Member Function Documentation
◆ getLibPath()
| std::string SST::ConfigShared::getLibPath | ( | bool | exclude_ext_paths = false | ) | const |
Get the library path for loading element libraries.
There are three places that paths can be specified and they are included in the path in the following order:
1 - command line arguments set using –lib-path and –add-lib-path 2 - paths set in environment variable SST_LIB_PATH 3 - paths set in sstsimulator.conf file 4 - (only for bootsst, Factory will not search this) LD_LIBRARY_PATH environment variable
The documentation for this class was generated from the following files:
- src/sst/core/configShared.h
- src/sst/core/configShared.cc
