FMI Library: part of JModelica.org
|
List of wrapper functions that are in common for both Model Exchange and Co-Simulation. More...
Functions | |
FMILIB_EXPORT const char * | fmi2_import_get_version (fmi2_import_t *fmu) |
Wrapper for the FMI function fmiGetVersion() More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_set_debug_logging (fmi2_import_t *fmu, fmi2_boolean_t loggingOn, size_t nCategories, fmi2_string_t categories[]) |
Wrapper for the FMI function fmiSetDebugLogging(...) More... | |
FMILIB_EXPORT jm_status_enu_t | fmi2_import_instantiate (fmi2_import_t *fmu, fmi2_string_t instanceName, fmi2_type_t fmuType, fmi2_string_t fmuResourceLocation, fmi2_boolean_t visible) |
Wrapper for the FMI function fmiInstantiate(...) More... | |
FMILIB_EXPORT void | fmi2_import_free_instance (fmi2_import_t *fmu) |
Wrapper for the FMI function fmiFreeInstance(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_setup_experiment (fmi2_import_t *fmu, fmi2_boolean_t toleranceDefined, fmi2_real_t tolerance, fmi2_real_t startTime, fmi2_boolean_t stopTimeDefined, fmi2_real_t stopTime) |
Calls the FMI function fmiSetupExperiment(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_enter_initialization_mode (fmi2_import_t *fmu) |
Calls the FMI function fmiEnterInitializationMode(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_exit_initialization_mode (fmi2_import_t *fmu) |
Calls the FMI function fmiExitInitializationMode(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_terminate (fmi2_import_t *fmu) |
Wrapper for the FMI function fmiTerminate(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_reset (fmi2_import_t *fmu) |
Wrapper for the FMI function fmiReset(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_set_real (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_real_t value[]) |
Wrapper for the FMI function fmiSetReal(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_set_integer (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t value[]) |
Wrapper for the FMI function fmiSetInteger(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_set_boolean (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_boolean_t value[]) |
Wrapper for the FMI function fmiSetBoolean(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_set_string (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_string_t value[]) |
Wrapper for the FMI function fmiSetString(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_get_real (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_real_t value[]) |
Wrapper for the FMI function fmiGetReal(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_get_integer (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_integer_t value[]) |
Wrapper for the FMI function fmiGetInteger(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_get_boolean (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_boolean_t value[]) |
Wrapper for the FMI function fmiGetBoolean(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_get_string (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, fmi2_string_t value[]) |
Wrapper for the FMI function fmiGetString(...) More... | |
FMILIB_EXPORT const char * | fmi2_import_get_types_platform (fmi2_import_t *fmu) |
Wrapper for the FMI function fmiGetTypesPlatform(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_get_fmu_state (fmi2_import_t *fmu, fmi2_FMU_state_t *s) |
Wrapper for the FMI function fmiGetFMUstate(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_set_fmu_state (fmi2_import_t *fmu, fmi2_FMU_state_t s) |
Wrapper for the FMI function fmiSetFMUstate(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_free_fmu_state (fmi2_import_t *fmu, fmi2_FMU_state_t *s) |
Wrapper for the FMI function fmiFreeFMUstate(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_serialized_fmu_state_size (fmi2_import_t *fmu, fmi2_FMU_state_t s, size_t *sz) |
Wrapper for the FMI function fmiSerializedFMUstateSize(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_serialize_fmu_state (fmi2_import_t *fmu, fmi2_FMU_state_t s, fmi2_byte_t data[], size_t sz) |
Wrapper for the FMI function fmiSerializeFMUstate(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_de_serialize_fmu_state (fmi2_import_t *fmu, const fmi2_byte_t data[], size_t sz, fmi2_FMU_state_t *s) |
Wrapper for the FMI function fmiSerializeFMUstate(...) More... | |
FMILIB_EXPORT fmi2_status_t | fmi2_import_get_directional_derivative (fmi2_import_t *fmu, const fmi2_value_reference_t v_ref[], size_t nv, const fmi2_value_reference_t z_ref[], size_t nz, const fmi2_real_t dv[], fmi2_real_t dz[]) |
Wrapper for the FMI function fmiGetDirectionalDerivative(...) More... | |
List of wrapper functions that are in common for both Model Exchange and Co-Simulation.
FMILIB_EXPORT const char* fmi2_import_get_version | ( | fmi2_import_t * | fmu | ) |
Wrapper for the FMI function fmiGetVersion()
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
FMILIB_EXPORT fmi2_status_t fmi2_import_set_debug_logging | ( | fmi2_import_t * | fmu, |
fmi2_boolean_t | loggingOn, | ||
size_t | nCategories, | ||
fmi2_string_t | categories[] | ||
) |
Wrapper for the FMI function fmiSetDebugLogging(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
loggingOn | Enable or disable the debug logger. |
nCategories | Number of categories to log. |
categories | Which categories to log. |
FMILIB_EXPORT jm_status_enu_t fmi2_import_instantiate | ( | fmi2_import_t * | fmu, |
fmi2_string_t | instanceName, | ||
fmi2_type_t | fmuType, | ||
fmi2_string_t | fmuResourceLocation, | ||
fmi2_boolean_t | visible | ||
) |
Wrapper for the FMI function fmiInstantiate(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
instanceName | The name of the instance. |
fmuType | fmi2_model_exchange or fmi2_cosimulation. |
fmuResourceLocation | Access path URI to the FMU archive resources. If this is NULL pointer the FMU will get the path to the unzipped location. |
visible | Indicates whether or not the simulator application window shoule be visible. |
FMILIB_EXPORT void fmi2_import_free_instance | ( | fmi2_import_t * | fmu | ) |
Wrapper for the FMI function fmiFreeInstance(...)
fmu | An fmu description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
FMILIB_EXPORT fmi2_status_t fmi2_import_setup_experiment | ( | fmi2_import_t * | fmu, |
fmi2_boolean_t | toleranceDefined, | ||
fmi2_real_t | tolerance, | ||
fmi2_real_t | startTime, | ||
fmi2_boolean_t | stopTimeDefined, | ||
fmi2_real_t | stopTime | ||
) |
Calls the FMI function fmiSetupExperiment(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
tolerance_defined | True if the tolerance argument is to be used |
tolerance | Solvers internal to the FMU should use this tolerance or finer, if tolerance_defined is true |
start_time | Start time of the experiment |
stop_time_defined | True if the stop_time argument is to be used |
stop_time | Stop time of the experiment, if stop_time_defined is true |
FMILIB_EXPORT fmi2_status_t fmi2_import_enter_initialization_mode | ( | fmi2_import_t * | fmu | ) |
Calls the FMI function fmiEnterInitializationMode(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
FMILIB_EXPORT fmi2_status_t fmi2_import_exit_initialization_mode | ( | fmi2_import_t * | fmu | ) |
Calls the FMI function fmiExitInitializationMode(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
FMILIB_EXPORT fmi2_status_t fmi2_import_terminate | ( | fmi2_import_t * | fmu | ) |
Wrapper for the FMI function fmiTerminate(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
FMILIB_EXPORT fmi2_status_t fmi2_import_reset | ( | fmi2_import_t * | fmu | ) |
Wrapper for the FMI function fmiReset(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
FMILIB_EXPORT fmi2_status_t fmi2_import_set_real | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
const fmi2_real_t | value[] | ||
) |
Wrapper for the FMI function fmiSetReal(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | Array of variable values. |
FMILIB_EXPORT fmi2_status_t fmi2_import_set_integer | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
const fmi2_integer_t | value[] | ||
) |
Wrapper for the FMI function fmiSetInteger(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | Array of variable values. |
FMILIB_EXPORT fmi2_status_t fmi2_import_set_boolean | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
const fmi2_boolean_t | value[] | ||
) |
Wrapper for the FMI function fmiSetBoolean(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | Array of variable values. |
FMILIB_EXPORT fmi2_status_t fmi2_import_set_string | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
const fmi2_string_t | value[] | ||
) |
Wrapper for the FMI function fmiSetString(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | Array of variable values. |
FMILIB_EXPORT fmi2_status_t fmi2_import_get_real | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
fmi2_real_t | value[] | ||
) |
Wrapper for the FMI function fmiGetReal(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | (Output)Array of variable values. |
FMILIB_EXPORT fmi2_status_t fmi2_import_get_integer | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
fmi2_integer_t | value[] | ||
) |
Wrapper for the FMI function fmiGetInteger(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | (Output)Array of variable values. |
FMILIB_EXPORT fmi2_status_t fmi2_import_get_boolean | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
fmi2_boolean_t | value[] | ||
) |
Wrapper for the FMI function fmiGetBoolean(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | (Output)Array of variable values. |
FMILIB_EXPORT fmi2_status_t fmi2_import_get_string | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | vr[], | ||
size_t | nvr, | ||
fmi2_string_t | value[] | ||
) |
Wrapper for the FMI function fmiGetString(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
vr | Array of value references. |
nvr | Number of array elements. |
value | (Output)Array of variable values. |
FMILIB_EXPORT const char* fmi2_import_get_types_platform | ( | fmi2_import_t * | fmu | ) |
Wrapper for the FMI function fmiGetTypesPlatform(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
FMILIB_EXPORT fmi2_status_t fmi2_import_get_fmu_state | ( | fmi2_import_t * | fmu, |
fmi2_FMU_state_t * | s | ||
) |
Wrapper for the FMI function fmiGetFMUstate(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
s | The state object to be set by the FMU |
FMILIB_EXPORT fmi2_status_t fmi2_import_set_fmu_state | ( | fmi2_import_t * | fmu, |
fmi2_FMU_state_t | s | ||
) |
Wrapper for the FMI function fmiSetFMUstate(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
s | The FMU state object |
FMILIB_EXPORT fmi2_status_t fmi2_import_free_fmu_state | ( | fmi2_import_t * | fmu, |
fmi2_FMU_state_t * | s | ||
) |
Wrapper for the FMI function fmiFreeFMUstate(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
s | The FMU state object |
FMILIB_EXPORT fmi2_status_t fmi2_import_serialized_fmu_state_size | ( | fmi2_import_t * | fmu, |
fmi2_FMU_state_t | s, | ||
size_t * | sz | ||
) |
Wrapper for the FMI function fmiSerializedFMUstateSize(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
s | The FMU state object |
sz | The size of the serialized state in bytes |
FMILIB_EXPORT fmi2_status_t fmi2_import_serialize_fmu_state | ( | fmi2_import_t * | fmu, |
fmi2_FMU_state_t | s, | ||
fmi2_byte_t | data[], | ||
size_t | sz | ||
) |
Wrapper for the FMI function fmiSerializeFMUstate(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
s | The FMU state object |
data | The buffer that will receive serialized FMU state |
sz | The size of the data buffer |
FMILIB_EXPORT fmi2_status_t fmi2_import_de_serialize_fmu_state | ( | fmi2_import_t * | fmu, |
const fmi2_byte_t | data[], | ||
size_t | sz, | ||
fmi2_FMU_state_t * | s | ||
) |
Wrapper for the FMI function fmiSerializeFMUstate(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
data | The buffer that contains serialized FMU state |
sz | The size of the data buffer |
s | The FMU state object to be created |
FMILIB_EXPORT fmi2_status_t fmi2_import_get_directional_derivative | ( | fmi2_import_t * | fmu, |
const fmi2_value_reference_t | v_ref[], | ||
size_t | nv, | ||
const fmi2_value_reference_t | z_ref[], | ||
size_t | nz, | ||
const fmi2_real_t | dv[], | ||
fmi2_real_t | dz[] | ||
) |
Wrapper for the FMI function fmiGetDirectionalDerivative(...)
fmu | A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu(). |
v_ref | Value references for the seed vector |
nv | size of v_ref array |
z_ref | Value references for the derivatives/outputs to be processed |
nz | Size of z_ref array |
dv | The seed vector. |
dz | Calculated directional derivative on output. |