SST  11.0.0
SST::Config Class Reference

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

#include <config.h>

Inheritance diagram for SST::Config:

Public Types

typedef bool(Config::* flagFunction )(void)
typedef bool(Config::* argFunction )(const std::string &arg)

Public Member Functions

 Config (RankInfo world_size)
 Create a new Config object. More...
int parseCmdLine (int argc, char *argv[])
 Parse command-line arguments to update configuration values. More...
bool setConfigEntryFromModel (const std::string &entryName, const std::string &value)
 Set a configuration string to update configuration values.
uint32_t getVerboseLevel ()
 Return the current Verbosity level.
bool printTimingInfo ()
 Print the SST core timing information.
void Print ()
 Print the current configuration to stdout.
bool usage ()
bool printVersion ()
bool incrVerbose ()
bool setVerbosity (const std::string &arg)
bool disableSigHandlers ()
bool disableEnvConfig ()
bool enablePrintTiming ()
bool enablePrintEnv ()
bool setConfigFile (const std::string &arg)
bool setDebugFile (const std::string &arg)
bool setLibPath (const std::string &arg)
bool addLibPath (const std::string &arg)
bool setRunMode (const std::string &arg)
bool setStopAt (const std::string &arg)
bool setStopAfter (const std::string &arg)
bool setHeartbeat (const std::string &arg)
bool setTimebase (const std::string &arg)
bool setPartitioner (const std::string &arg)
bool setTimeVortex (const std::string &arg)
bool setOutputDir (const std::string &arg)
bool setWriteConfig (const std::string &arg)
bool setWriteDot (const std::string &arg)
bool setDotVerbosity (const std::string &arg)
bool setWriteXML (const std::string &arg)
bool setWriteJSON (const std::string &arg)
bool setWritePartition (const std::string &arg)
bool setOutputPrefix (const std::string &arg)
bool setModelOptions (const std::string &arg)
bool setNumThreads (const std::string &arg)
Simulation::Mode_t getRunMode ()
void print ()
 Print to stdout the current configuration.
std::string getLibPath (void) const
 Return the library search path.
uint32_t getNumRanks ()
uint32_t getNumThreads ()
uint32_t setNumThreads (uint32_t nthr)
void serialize_order (SST::Core::Serialization::serializer &ser) override
- Public Member Functions inherited from SST::Core::Serialization::serializable
virtual const char * cls_name () const =0
virtual uint32_t cls_id () const =0
virtual std::string serialization_name () const =0

Data Fields

std::string debugFile
Simulation::Mode_t runMode
std::string configFile
std::string stopAtCycle
uint32_t stopAfterSec
std::string heartbeatPeriod
std::string timeBase
std::string partitioner
std::string timeVortex
std::string output_config_graph
std::string output_dot
uint32_t dot_verbosity
std::string output_xml
std::string output_json
std::string output_directory
std::string model_options
std::string dump_component_graph_file
std::string output_core_prefix
RankInfo world_size
uint32_t verbose
bool no_env_config
bool enable_sig_handling
bool print_timing
bool print_env

Additional Inherited Members

- Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
- Protected Types inherited from SST::Core::Serialization::serializable
enum  cxn_flag_t { ConstructorFlag }
- Static Protected Member Functions inherited from SST::Core::Serialization::serializable
static void serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)

Detailed Description

Class to contain SST Simulation Configuration variables.

Constructor & Destructor Documentation

SST::Config::Config ( RankInfo  world_size)

Create a new Config object.

my_rank- parallel rank of this instance
world_size- number of parallel ranks in the simulation

Member Function Documentation

int SST::Config::parseCmdLine ( int  argc,
char *  argv[] 

Parse command-line arguments to update configuration values.

Returns 0 if execution should continue. Returns -1 if there was an error. Returns 1 if run command line only asked for information to be print (e.g. –help or -V).

Field Documentation

std::string SST::Config::configFile

Graph generation file

Referenced by print().

std::string SST::Config::debugFile

File to which debug information should be written

Referenced by print().

uint32_t SST::Config::dot_verbosity

Amount of detail to include in the dot graph output

Referenced by print().

std::string SST::Config::dump_component_graph_file

File to dump component graph

bool SST::Config::enable_sig_handling

Enable signal handling

Referenced by print().

std::string SST::Config::heartbeatPeriod

Sets the heartbeat period for the simulation

std::string SST::Config::model_options

Options to pass to Python Model generator

Referenced by print().

bool SST::Config::no_env_config

Bypass compile-time environmental configuration

Referenced by print().

std::string SST::Config::output_config_graph

File to dump configuration graph

Referenced by print().

std::string SST::Config::output_core_prefix

Set the SST::Output prefix for the core

Referenced by print().

std::string SST::Config::output_directory

Output directory to dump all files to

Referenced by print().

std::string SST::Config::output_dot

File to dump dot output

Referenced by print().

std::string SST::Config::output_json

File to dump JSON output

Referenced by print().

std::string SST::Config::output_xml

File to dump XML output

Referenced by print().

std::string SST::Config::partitioner

Partitioner to use

Referenced by print().

bool SST::Config::print_env

Print SST environment

Referenced by print().

bool SST::Config::print_timing

Print SST timing information

Referenced by print().

Simulation::Mode_t SST::Config::runMode

Run Mode (Init, Both, Run-only)

Referenced by print().

uint32_t SST::Config::stopAfterSec

When (wall-time) to stop the simulation

Referenced by print().

std::string SST::Config::stopAtCycle

When to stop the simulation

Referenced by print(), and SST::Simulation_impl::setStopAtCycle().

std::string SST::Config::timeBase

Timebase of simulation

Referenced by print().

std::string SST::Config::timeVortex

TimeVortex implementation to use

uint32_t SST::Config::verbose


RankInfo SST::Config::world_size

Number of ranks, threads which should be invoked per rank

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