roadrunner  2.6.0
Fast simulator for SBML models
Static Public Member Functions | List of all members
rr::IntegratorFactory Class Reference

Constructs new integrators. More...

#include <IntegratorFactory.h>

Inheritance diagram for rr::IntegratorFactory:
rr::RegistrationFactory

Static Public Member Functions

static IntegratorFactorygetInstance ()
 get an instance of this IntegratorFactory. More...
 
static void Register ()
 Registers all integrators at startup. More...
 
- Static Public Member Functions inherited from rr::RegistrationFactory
template<class FactoryType >
static FactoryType & getInstance (std::mutex &mutex)
 Returns the singleton instance of the integrator factory. More...
 

Additional Inherited Members

- Public Member Functions inherited from rr::RegistrationFactory
SolverNew (const std::string &name, ExecutableModel *m) const
 Constructs a new integrator given the name (e.g. cvode, gillespie) More...
 
virtual void registerSolver (Registrable *i)
 Registers a new integrator with the factory so that it can be constructed. More...
 
virtual std::size_t size () const
 
virtual std::string name (std::size_t n) const
 
virtual std::string hint (std::size_t n) const
 
virtual std::string description (std::size_t n) const
 
- Protected Member Functions inherited from rr::RegistrationFactory
 RegistrationFactory ()=default
 Prevents external instantiation. More...
 
- Protected Attributes inherited from rr::RegistrationFactory
RegistrableVector registrars
 

Detailed Description

Constructs new integrators.

This is a singleton class. All methods except for getInstance are fully determined by superclass FactoryWithRegistration.

Member Function Documentation

◆ getInstance()

IntegratorFactory & rr::IntegratorFactory::getInstance ( )
static

get an instance of this IntegratorFactory.

If one exists return is otherwise create one. This method implements the sigleton pattern and is thread safe due to use of std::mutex.

◆ Register()

void rr::IntegratorFactory::Register ( )
static

Registers all integrators at startup.

Author
JKM

Is run at first instantiation of RoadRunner. Subsequent calls have no effect.


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