ForSyDe::CT::fmi2cswrap Class Reference

Process constructor for a co-simulation FMU wrapper with one input and one output. More...

#include <ct_wrappers.hpp>

Inheritance diagram for ForSyDe::CT::fmi2cswrap:
Collaboration diagram for ForSyDe::CT::fmi2cswrap:

Public Member Functions

 fmi2cswrap (sc_module_name _name, const std::string &fmu_file, const unsigned int &input_index, const unsigned int &output_index, const sc_time &sample_period)
 The constructor requires the module name. More...
 
std::string forsyde_kind () const
 Specifying from which process constructor is the module built.
 
- Public Member Functions inherited from ForSyDe::process
 process (sc_module_name _name)
 The constructor requires the module name. More...
 

Public Attributes

CT_in iport1
 port for the input channel
 
CT_out oport1
 port for the output channel
 

Additional Inherited Members

- Protected Member Functions inherited from ForSyDe::process
void end_of_simulation ()
 This hook is used to run the clean stage.
 

Detailed Description

Process constructor for a co-simulation FMU wrapper with one input and one output.

This class is used to build an FMI wrapper with one input and one output. It uses the Functional Mock-up Interface (FMI 2.0) in co-simulation mode to communicate with a Functional Mock-up Unit (FMU) which includes a numeric solver or interfaces to a solver tool.

Constructor & Destructor Documentation

ForSyDe::CT::fmi2cswrap::fmi2cswrap ( sc_module_name  _name,
const std::string &  fmu_file,
const unsigned int &  input_index,
const unsigned int &  output_index,
const sc_time &  sample_period 
)
inline

The constructor requires the module name.

It creates an SC_THREAD which reads data from its input port, applies the user-imlpemented function to it and writes the results using the output port

Parameters
_nameprocess name
fmu_fileThe FMU file name
input_indexThe index of input variable
output_indexThe index of output variable
sample_periodThe fixed sampling period

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