coral
A C++ library for distributed co-simulation
Public Member Functions | List of all members
coral::fmi::SlaveInstance Class Referenceabstract

An FMI co-simulation slave instance. More...

#include "coral/fmi/fmu.hpp"

Inheritance diagram for coral::fmi::SlaveInstance:
coral::slave::Instance coral::fmi::SlaveInstance1 coral::fmi::SlaveInstance2

Public Member Functions

virtual std::shared_ptr< coral::fmi::FMUFMU () const =0
 Returns a reference to the FMU of which this is an instance.
 
- Public Member Functions inherited from coral::slave::Instance
virtual coral::model::SlaveTypeDescription TypeDescription () const =0
 Returns an object that describes the slave type.
 
virtual void Setup (const std::string &slaveName, const std::string &executionName, coral::model::TimePoint startTime, coral::model::TimePoint stopTime, bool adaptiveStepSize, double relativeTolerance)=0
 Instructs the slave to perform pre-simulation setup and enter initialisation mode. More...
 
virtual void StartSimulation ()=0
 Informs the slave that the initialisation stage ends and the simulation begins.
 
virtual void EndSimulation ()=0
 Informs the slave that the simulation run has ended.
 
virtual bool DoStep (coral::model::TimePoint currentT, coral::model::TimeDuration deltaT)=0
 Performs model calculations for the time step which starts at the time point currentT and has a duration of deltaT. More...
 
virtual double GetRealVariable (coral::model::VariableID variable) const =0
 Returns the value of a real variable. More...
 
virtual int GetIntegerVariable (coral::model::VariableID variable) const =0
 Returns the value of an integer variable. More...
 
virtual bool GetBooleanVariable (coral::model::VariableID variable) const =0
 Returns the value of a boolean variable. More...
 
virtual std::string GetStringVariable (coral::model::VariableID variable) const =0
 Returns the value of a string variable. More...
 
virtual bool SetRealVariable (coral::model::VariableID variable, double value)=0
 Sets the value of a real variable. More...
 
virtual bool SetIntegerVariable (coral::model::VariableID variable, int value)=0
 Sets the value of an integer variable. More...
 
virtual bool SetBooleanVariable (coral::model::VariableID variable, bool value)=0
 Sets the value of a boolean variable. More...
 
virtual bool SetStringVariable (coral::model::VariableID variable, const std::string &value)=0
 Sets the value of a string variable. More...
 

Detailed Description

An FMI co-simulation slave instance.


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