C API Documentation
Public Member Functions | Protected Types | List of all members
rr::IntegratorRegistrar Class Referenceabstract

Handles constructing an integrator and contains meta information about it. More...

#include <Integrator.h>

Inheritance diagram for rr::IntegratorRegistrar:
rr::CVODEIntegratorRegistrar rr::GillespieIntegratorRegistrar rr::RK45IntegratorRegistrar rr::RK4IntegratorRegistrar

Public Member Functions

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

Protected Types

typedef Integrator *(* IntegratorCtor) (ExecutableModel *model)
 

Detailed Description

Handles constructing an integrator and contains meta information about it.

Author
JKM, WBC

Member Function Documentation

◆ construct()

virtual Integrator* rr::IntegratorRegistrar::construct ( ExecutableModel model) const
pure virtual

Constructs a new integrator of a given type.

Author
JKM, WBC

Implemented in rr::CVODEIntegratorRegistrar, rr::RK4IntegratorRegistrar, rr::RK45IntegratorRegistrar, and rr::GillespieIntegratorRegistrar.

◆ getDescription()

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

Gets the description associated with this integrator type.

Author
JKM, WBC

Implemented in rr::CVODEIntegratorRegistrar, rr::RK4IntegratorRegistrar, rr::RK45IntegratorRegistrar, and rr::GillespieIntegratorRegistrar.

◆ getHint()

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

Gets the hint associated with this integrator type.

Author
JKM, WBC

Implemented in rr::CVODEIntegratorRegistrar, rr::RK4IntegratorRegistrar, rr::RK45IntegratorRegistrar, and rr::GillespieIntegratorRegistrar.

◆ getName()

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

Gets the name associated with this integrator type.

Author
JKM, WBC

Implemented in rr::CVODEIntegratorRegistrar, rr::RK4IntegratorRegistrar, rr::RK45IntegratorRegistrar, and rr::GillespieIntegratorRegistrar.


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