roadrunner  2.6.0
Fast simulator for SBML models
Public Member Functions | List of all members
rr::Registrable Class Referenceabstract

Handles constructing a solver and contains meta information about it. More...

#include <Registrable.h>

Inheritance diagram for rr::Registrable:
rr::Solver rr::Integrator rr::SensitivitySolver rr::SteadyStateSolver rr::CVODEIntegrator rr::EulerIntegrator rr::GillespieIntegrator rr::RK45Integrator rr::RK4Integrator rr::SteadyStateSensitivitySolver rr::TimeSeriesSensitivitySolver rr::KinsolSteadyStateSolver rr::NLEQSolver rr::SteadyStateSolverDecorator

Public Member Functions

virtual std::string getName () const =0
 Gets the name associated with this Solver type. More...
 
virtual std::string getDescription () const =0
 Gets the description associated with this Solver type. More...
 
virtual std::string getHint () const =0
 Gets the hint associated with this Solver type. More...
 
virtual Solverconstruct (ExecutableModel *model) const =0
 Constructs a new Solver of a given type. More...
 

Detailed Description

Handles constructing a solver and contains meta information about it.

Author
JKM, WBC

Member Function Documentation

◆ construct()

virtual Solver* rr::Registrable::construct ( ExecutableModel model) const
pure virtual

Constructs a new Solver of a given type.

Author
JKM, WBC

the caller is responsible for deleting memory associated with the returned Solver*.

Implemented in rr::RK4Integrator, rr::LinesearchNewtonIteration, rr::BasicNewtonIteration, rr::PresimulationProgramDecorator, rr::PresimulationDecorator, rr::GillespieIntegrator, rr::ForwardSensitivitySolver, rr::EulerIntegrator, rr::CVODEIntegrator, and rr::RK45Integrator.

◆ getDescription()

virtual std::string rr::Registrable::getDescription ( ) const
pure virtual

◆ getHint()

virtual std::string rr::Registrable::getHint ( ) const
pure virtual

◆ getName()

virtual std::string rr::Registrable::getName ( ) const
pure virtual

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