An FMI co-simulation slave instance. More...
#include <cosim/fmi/fmu.hpp>
Inheritance diagram for cosim::fmi::slave_instance:
Public Member Functions | |
| virtual std::shared_ptr< fmi::fmu > | fmu () const =0 |
| Returns a reference to the FMU of which this is an instance. More... | |
| cosim::model_description | model_description () const final override |
| Returns a model description. More... | |
 Public Member Functions inherited from cosim::slave | |
| virtual void | setup (time_point startTime, std::optional< time_point > stopTime, std::optional< double > relativeTolerance)=0 |
| Instructs the slave to perform pre-simulation setup and enter initialisation mode. More... | |
| virtual void | start_simulation ()=0 |
| Informs the slave that the initialisation stage ends and the simulation begins. More... | |
| virtual void | end_simulation ()=0 |
| Informs the slave that the simulation run has ended. More... | |
| virtual step_result | do_step (time_point currentT, duration deltaT)=0 |
Performs model calculations for the time step which starts at the time point currentT and has a duration of deltaT. More... | |
| virtual void | get_real_variables (gsl::span< const value_reference > variables, gsl::span< double > values) const =0 |
| Retrieves the values of real variables. More... | |
| virtual void | get_integer_variables (gsl::span< const value_reference > variables, gsl::span< int > values) const =0 |
| Retrieves the values of integer variables. More... | |
| virtual void | get_boolean_variables (gsl::span< const value_reference > variables, gsl::span< bool > values) const =0 |
| Retrieves the values of boolean variables. More... | |
| virtual void | get_string_variables (gsl::span< const value_reference > variables, gsl::span< std::string > values) const =0 |
| Retrieves the values of string variables. More... | |
| virtual void | set_real_variables (gsl::span< const value_reference > variables, gsl::span< const double > values)=0 |
| Sets the values of real variables. More... | |
| virtual void | set_integer_variables (gsl::span< const value_reference > variables, gsl::span< const int > values)=0 |
| Sets the values of integer variables. More... | |
| virtual void | set_boolean_variables (gsl::span< const value_reference > variables, gsl::span< const bool > values)=0 |
| Sets the values of boolean variables. More... | |
| virtual void | set_string_variables (gsl::span< const value_reference > variables, gsl::span< const std::string > values)=0 |
| Sets the values of string variables. More... | |
Detailed Description
An FMI co-simulation slave instance.
Member Function Documentation
◆ fmu()
|
pure virtual |
Returns a reference to the FMU of which this is an instance.
Implemented in cosim::fmi::v1::slave_instance, and cosim::fmi::v2::slave_instance.
◆ model_description()
|
inlinefinaloverridevirtual |
Returns a model description.
Implements cosim::slave.
The documentation for this class was generated from the following file:
- cosim/fmi/fmu.hpp
