SST  14.1.0
StructuralSimulationToolkit
SST::ConfigShared Class Reference

Class to contain SST Simulation Configuration variables. More...

#include <configShared.h>

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

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...
 
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 (void) 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)
 
 ConfigShared (bool suppress_print, std::vector< AnnotationInfo > annotations)
 ConfigShared constructor for child classes.
 
 ConfigShared ()
 Default constructor used for serialization. More...
 
- Protected Member Functions inherited from SST::ConfigBase
 ConfigBase (bool suppress_print)
 ConfigBase constructor. More...
 
 ConfigBase ()
 Default constructor used for serialization. More...
 
 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(void)> ext_help=std::function< std::string(void)>())
 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 ()
 
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. 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.
 

Protected Attributes

std::string libpath_ = ""
 
std::string addlibpath_ = ""
 
bool print_env_ = false
 
bool no_env_config_ = false
 
int verbose_ = 0
 

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)
 

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() [1/2]

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

◆ ConfigShared() [2/2]

SST::ConfigShared::ConfigShared ( )
inlineprotected

Default constructor used for serialization.

At this point, my_rank is no longer needed, so just initialize to 0,0.

Member Function Documentation

◆ getLibPath()

std::string SST::ConfigShared::getLibPath ( void  ) 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: