SST::Config Class Reference

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

#include <config.h>

Public Types
enum	Mode_t { UNKNOWN, INIT, RUN, BOTH }
	Type of Run Modes. More...
Public Member Functions
	Config (int my_rank, int world_size)
	Create a new Config object.
int	parseCmdLine (int argc, char *argv[])
	Parse command-line arguments to update configuration values.
int	parseConfigFile (std::string config_string)
	Parse a configuration string to update configuration values.
uint32_t	getVerboseLevel ()
	Return the current Verbosity level.
void	setStopAt (std::string stopAtStr)
	Set the cycle at which to stop the simulation.
void	setTimeBase (std::string timeBase)
	Sets the default timebase of the simulation.
void	Print ()
	Print the current configuration to stdout.
Mode_t	setRunMode (std::string mode)
	Set the run-mode.
Mode_t	getRunMode ()
void	print ()
	Print to stdout the current configuration.
std::string	getLibPath (void) const
	Return the library search path.
int	getRank () const
	Return the current Parallel Rank.
int	getNumRanks () const
	Return the number of parallel ranks in the simulation.
Data Fields
std::string	debugFile
Mode_t	runMode
std::string	sdlfile
std::string	stopAtCycle
std::string	heartbeatPeriod
std::string	timeBase
std::string	partitioner
std::string	generator
std::string	generator_options
std::string	output_config_graph
std::string	output_dot
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
uint32_t	verbose
bool	no_env_config
bool	enable_sig_handling
Friends
class	boost::serialization::access

---

Detailed Description

Class to contain SST Simulation Configuration variables.

---

Member Enumeration Documentation

enum SST::Config::Mode_t

Type of Run Modes.

Enumerator:

UNKNOWN	Unknown mode - Invalid for running
INIT	Initialize-only. Useful for debugging initialization and graph generation
RUN	Run-only. Useful when restoring from a checkpoint
BOTH	Default. Both initialize and Run the simulation

---

Constructor & Destructor Documentation

SST::Config::Config	(	int	my_rank,
		int	world_size
	)

Create a new Config object.

Parameters:

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

References BOTH, debugFile, dump_component_graph_file, enable_sig_handling, generator, generator_options, heartbeatPeriod, model_options, no_env_config, output_config_graph, output_core_prefix, output_directory, output_dot, output_json, output_xml, partitioner, runMode, sdlfile, stopAtCycle, timeBase, and verbose.

---

Member Function Documentation

Mode_t SST::Config::setRunMode

(

std::string

mode

)

[inline]

Set the run-mode.

Parameters:

mode

- string "init" "run" "both"

Returns:

the Mode_t corresponding

References BOTH, INIT, RUN, and UNKNOWN.

---

Field Documentation

std::string SST::Config::debugFile

File to which debug information should be written

Referenced by Config(), parseCmdLine(), and print().

std::string SST::Config::dump_component_graph_file

File to dump component graph

Referenced by Config().

bool SST::Config::enable_sig_handling

Enable signal handling

Referenced by Config(), parseCmdLine(), and print().

std::string SST::Config::generator

Generator to use

Referenced by Config(), parseCmdLine(), and print().

std::string SST::Config::generator_options

Options to pass to the generator

Referenced by Config(), and print().

std::string SST::Config::heartbeatPeriod

Sets the heartbeat period for the simulation

Referenced by Config().

std::string SST::Config::model_options

Options to pass to Python Model generator

Referenced by Config(), and print().

bool SST::Config::no_env_config

Bypass compile-time environmental configuration

Referenced by Config(), and print().

std::string SST::Config::output_config_graph

File to dump configuration graph

Referenced by Config(), and print().

std::string SST::Config::output_core_prefix

Set the SST::Output prefix for the core

Referenced by Config(), and print().

std::string SST::Config::output_directory

Output directory to dump all files to

Referenced by Config(), and print().

std::string SST::Config::output_dot

File to dump dot output

Referenced by Config().

std::string SST::Config::output_json

File to dump JSON output

Referenced by Config(), and print().

std::string SST::Config::output_xml

File to dump XML output

Referenced by Config(), and print().

std::string SST::Config::partitioner

Partitioner to use

Referenced by Config(), and print().

Mode_t SST::Config::runMode

Run Mode (Init, Both, Run-only)

Referenced by Config(), and print().

std::string SST::Config::sdlfile

Graph generation file

Referenced by Config(), parseCmdLine(), and print().

std::string SST::Config::stopAtCycle

When to stop the simulation

Referenced by Config(), print(), setStopAt(), and SST::Simulation::setStopAtCycle().

std::string SST::Config::timeBase

Timebase of simulation

Referenced by Config(), print(), setTimeBase(), and SST::SimulationBase::SimulationBase().

uint32_t SST::Config::verbose

Verbosity

Referenced by Config(), getVerboseLevel(), and parseCmdLine().

---

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

• sst/core/config.h
• sst/core/config.cc