roadrunner
2.6.0
Fast simulator for SBML models
|
The base class Decorator follows the same interface as other SteadyStateSolvers. More...
#include <SteadyStateSolverDecorator.h>
Public Member Functions | |
SteadyStateSolverDecorator (SteadyStateSolver *solver) | |
void | syncWithModel (ExecutableModel *m) override |
Base decorator delegates all work to the wrapped steady state solver. More... | |
double | solve () override |
std::string | getName () const override |
Gets the name associated with this Solver type. More... | |
std::string | getDescription () const override |
Gets the description associated with this Solver type. More... | |
std::string | getHint () const override |
Gets the hint associated with this Solver type. More... | |
void | resetSettings () override |
Implements settings shared by all steady state solvers. | |
![]() | |
virtual void | loadConfigSettings () |
std::string | toString () const override |
Return a std::string representation of the solver. More... | |
std::string | toRepr () const override |
Return std::string representation a la Python repr method. More... | |
Solver ()=default | |
Solver (ExecutableModel *model) | |
![]() | |
Solver (ExecutableModel *model) | |
void | updateSettings (Dictionary *inputSettings) |
Update settings values. More... | |
std::vector< std::string > | getSettings () const |
Get a list of all settings for this solver. More... | |
std::unordered_map< std::string, Setting > & | getSettingsMap () |
get settings for this solver More... | |
virtual Setting | getValue (const std::string &key) const |
Get the value of an integrator setting. More... | |
virtual Setting | hasValue (const std::string &key) const |
Return true if this setting is supported by the integrator. More... | |
virtual size_t | getNumParams () const |
Get the number of parameters. More... | |
virtual std::string | getParamName (size_t n) const |
Get the name of the parameter at index n. More... | |
virtual std::string | getParamDisplayName (int n) const |
Get the display name of the parameter at index n. More... | |
virtual std::string | getParamHint (int n) const |
Get the hint of the parameter at index n. More... | |
virtual std::string | getParamDesc (int n) const |
Get the description of the parameter at index n. More... | |
virtual std::string | getValueAsString (const std::string &key) |
Wrapper for getValue which converts output to a specific type. More... | |
virtual void | setValue (const std::string &key, Setting value) |
virtual std::string | getSettingsRepr () const |
Get the solver settings as a std::string. More... | |
virtual std::string | settingsPyDictRepr () const |
Python dictionary-style std::string representation of settings. More... | |
const std::string & | getDisplayName (const std::string &key) const |
Gets the hint associated with a given key. More... | |
const std::string & | getHint (const std::string &key) const |
Gets the hint associated with a given key. More... | |
const std::string & | getDescription (const std::string &key) const |
Gets the description associated with a given key. More... | |
Setting::TypeId | getType (const std::string &key) const |
Gets the type associated with a given key. More... | |
virtual ExecutableModel * | getModel () const |
returns the pointer to the ExecutableModel | |
virtual std::string | getName () const=0 |
Gets the name associated with this Solver type. More... | |
virtual std::string | getHint () const=0 |
Gets the hint associated with this Solver type. More... | |
virtual std::string | getDescription () const=0 |
Gets the description associated with this Solver type. More... | |
![]() | |
virtual Solver * | construct (ExecutableModel *model) const =0 |
Constructs a new Solver of a given type. More... | |
Protected Attributes | |
SteadyStateSolver * | solver_ |
![]() | |
ExecutableModel * | mModel = nullptr |
non-owning pointer to model | |
Additional Inherited Members | |
![]() | |
using | SettingsList = std::vector< std::string > |
using | SettingsMap = std::unordered_map< std::string, Setting > |
using | DisplayNameMap = std::unordered_map< std::string, std::string > |
using | HintMap = std::unordered_map< std::string, std::string > |
using | DescriptionMap = std::unordered_map< std::string, std::string > |
![]() | |
SettingsList | sorted_settings |
SettingsMap | settings |
DisplayNameMap | display_names_ |
HintMap | hints |
DescriptionMap | descriptions |
![]() | |
void | addSetting (const std::string &name, const Setting &val, const std::string &display_name, const std::string &hint, const std::string &description) |
The base class Decorator follows the same interface as other SteadyStateSolvers.
The primary purpose of this class is the define the wrapping interface for all concrete decorators. The default implementation of the wrapping code might include a field for storing a wrapped component and a means to initialize it.
|
overridevirtual |
Gets the description associated with this Solver type.
Implements rr::Registrable.
|
overridevirtual |
Gets the hint associated with this Solver type.
Implements rr::Registrable.
|
overridevirtual |
Gets the name associated with this Solver type.
Implements rr::Registrable.
|
overridevirtual |
Base decorator delegates all work to the wrapped steady state solver.
Subclass decorators may modify any or all of these operations.
Implements rr::Solver.