SST 12.1.0
Structural Simulation Toolkit
SST::SSTModelDescription Class Referenceabstract

Base class for Model Generation. More...

#include <sstmodel.h>

Inheritance diagram for SST::SSTModelDescription:
SST::Core::SSTJSONModelDefinition SST::Core::SSTPythonModelDefinition SST::Core::SSTXmlModelDefinition

Public Member Functions

 SSTModelDescription (Config *cfg)
virtual ConfigGraphcreateConfigGraph ()=0
 Create the ConfigGraph. More...

Static Public Member Functions

static SST_ELI_DECLARE_INFO_EXTERN(ELI::ProvidesSimpleInfo< 0, bool >, ELI::ProvidesSimpleInfo< 1, std::vector< std::string > >) static bool isElementParallelCapable(const std const std::vector< std::string > & getElementSupportedExtensions (const std::string &type)

Protected Member Functions

bool setOptionFromModel (const std::string &entryName, const std::string &value)
 Set a configuration string to update configuration values.
void setModelOptions (const std::string &options)
 Sets the model options field of the Config object. More...
void insertGlobalParameter (const std::string &set, const Params::key_type &key, const Params::key_type &value, bool overwrite=true)
 Allows ModelDefinition to set global parameters. More...

Detailed Description

Base class for Model Generation.

Member Function Documentation

◆ createConfigGraph()

virtual ConfigGraph * SST::SSTModelDescription::createConfigGraph ( )
pure virtual

Create the ConfigGraph.

This function should be overridden by subclasses.

This function is responsible for reading any configuration files and generating a ConfigGraph object.

Implemented in SST::Core::SSTJSONModelDefinition, SST::Core::SSTPythonModelDefinition, and SST::Core::SSTXmlModelDefinition.

◆ insertGlobalParameter()

void SST::SSTModelDescription::insertGlobalParameter ( const std::string &  set,
const Params::key_type key,
const Params::key_type value,
bool  overwrite = true 

Allows ModelDefinition to set global parameters.

setName of the global param set to add key/value pair to
keyKey of key/value pair to be added
keyValue of key/value pair to be added
overwriteOverwrite existing value if set to true (which is default)

◆ setModelOptions()

void SST::SSTModelDescription::setModelOptions ( const std::string &  options)

Sets the model options field of the Config object.

This has a very narrow use case, which is to set the model_options when the model is just a wrapper to another model type and they need to pass some extra options.

optionsString that will be used for model_options. It will overwrite what is alread there

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