instance.hpp

Go to the documentation of this file.

#ifndef CORAL_SLAVE_INSTANCE_HPP
#define CORAL_SLAVE_INSTANCE_HPP

#include <string>
#include <coral/model.hpp>

namespace coral
{
namespace slave
{


class Instance
{
public:
    virtual coral::model::SlaveTypeDescription TypeDescription() const = 0;

    virtual void Setup(
        const std::string& slaveName,
        const std::string& executionName,
        coral::model::TimePoint startTime,
        coral::model::TimePoint stopTime,
        bool adaptiveStepSize,
        double relativeTolerance) = 0;

    virtual void StartSimulation() = 0;

    virtual void EndSimulation() = 0;

    virtual bool DoStep(
        coral::model::TimePoint currentT,
        coral::model::TimeDuration deltaT) = 0;

    virtual double GetRealVariable(coral::model::VariableID variable) const = 0;

    virtual int GetIntegerVariable(coral::model::VariableID variable) const = 0;

    virtual bool GetBooleanVariable(coral::model::VariableID variable) const = 0;

    virtual std::string GetStringVariable(coral::model::VariableID variable) const = 0;

    virtual bool SetRealVariable(coral::model::VariableID variable, double value) = 0;

    virtual bool SetIntegerVariable(coral::model::VariableID variable, int value) = 0;

    virtual bool SetBooleanVariable(coral::model::VariableID variable, bool value) = 0;

    virtual bool SetStringVariable(coral::model::VariableID variable, const std::string& value) = 0;

    // Because it's an interface:
    virtual ~Instance() { }
};


}}
#endif // header guard