<< FMI Support fmu_wrapper fmu_link >>

fmu_wrapper >> fmu_wrapper > fmu_call

fmu_call

(Internal) Call FMI model exported functions.

Calling Sequence

[status, ...] = fmu_call(library, 'fmiXXX', instance, ...);

Arguments

library

handle to the library.

'fmiXXX'

string, name of a standard FMI function.

instance

pointer, an instance of the FMU model.

status

double, returns status of standard FMI function call. The values are :

  • 0, fmiOk
  • 1, fmiWarning there are things not quite right, but the computation can continue.
  • 2, fmiDiscard it is recommended to perform a smaller step size and evaluate the model equations again.
  • 3, fmiError the model encountered an error, the simulation cannot be continued with this model instance and function fmiFreeModelInstance(..) must be called.
  • 4, fmiFatal the model computations are irreparably corrupted for all model instances.

...

Any FMI function argument is a Scilab type, C output argument (passed by reference) are passed as Scilab output arguments.

Description

Internal function which is used by Scilab macros that implement standards FMI functions.

fmu_call is the function which calls a function provided by the dynamic library (.dll for Windows and .so for Linux) of an FMU. If this function succeeds, the status return value indicates the success or fails of the FMI function call.

See Also


Report an issue
<< FMI Support fmu_wrapper fmu_link >>