FMI Library: part of JModelica.org
Functions
fmi2_import_capi.h File Reference
#include <JM/jm_callbacks.h>
#include <FMI/fmi_import_util.h>
#include <FMI/fmi_import_context.h>
#include <FMI2/fmi2_types.h>
#include <FMI2/fmi2_functions.h>
#include <FMI2/fmi2_enums.h>

Go to the source code of this file.

Functions

FMILIB_EXPORT jm_status_enu_t fmi2_import_create_dllfmu (fmi2_import_t *fmu, fmi2_fmu_kind_enu_t fmuKind, const fmi2_callback_functions_t *callBackFunctions)
 Create a C-API struct. The C-API struct is a placeholder for the FMI DLL functions. More...
 
FMILIB_EXPORT void fmi2_import_destroy_dllfmu (fmi2_import_t *fmu)
 Free a C-API struct. All memory allocated since the struct was created is freed. More...
 
FMILIB_EXPORT void fmi2_import_set_debug_mode (fmi2_import_t *fmu, int mode)
 Set CAPI debug mode flag. Setting to non-zero prevents DLL unloading in fmi2_import_destroy_dllfmu while all the memory is deallocated. This is to support valgrind debugging. More...
 
FMILIB_EXPORT const charfmi2_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 charfmi2_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...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_enter_event_mode (fmi2_import_t *fmu)
 Calls the FMI function fmiEnterEventMode(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_new_discrete_states (fmi2_import_t *fmu, fmi2_event_info_t *eventInfo)
 Calls the FMI function fmiNewDiscreteStates(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_enter_continuous_time_mode (fmi2_import_t *fmu)
 Calls the FMI function fmiEnterContinuousTimeMode(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_set_time (fmi2_import_t *fmu, fmi2_real_t time)
 Wrapper for the FMI function fmiSetTime(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_set_continuous_states (fmi2_import_t *fmu, const fmi2_real_t x[], size_t nx)
 Wrapper for the FMI function fmiSetContinuousStates(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_completed_integrator_step (fmi2_import_t *fmu, fmi2_boolean_t noSetFMUStatePriorToCurrentPoint, fmi2_boolean_t *enterEventMode, fmi2_boolean_t *terminateSimulation)
 Wrapper for the FMI function fmiCompletedIntegratorStep(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_derivatives (fmi2_import_t *fmu, fmi2_real_t derivatives[], size_t nx)
 Wrapper for the FMI function fmiGetDerivatives(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_event_indicators (fmi2_import_t *fmu, fmi2_real_t eventIndicators[], size_t ni)
 Wrapper for the FMI function fmiGetEventIndicators(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_continuous_states (fmi2_import_t *fmu, fmi2_real_t states[], size_t nx)
 Wrapper for the FMI function fmiGetContinuousStates(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_nominals_of_continuous_states (fmi2_import_t *fmu, fmi2_real_t x_nominal[], size_t nx)
 Wrapper for the FMI function fmiGetNominalsOfContinuousStates(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_set_real_input_derivatives (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t order[], const fmi2_real_t value[])
 Wrapper for the FMI function fmiSetRealInputDerivatives(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_real_output_derivatives (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t order[], fmi2_real_t value[])
 Wrapper for the FMI function fmiGetOutputDerivatives(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_cancel_step (fmi2_import_t *fmu)
 Wrapper for the FMI function fmiCancelStep(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_do_step (fmi2_import_t *fmu, fmi2_real_t currentCommunicationPoint, fmi2_real_t communicationStepSize, fmi2_boolean_t newStep)
 Wrapper for the FMI function fmiDoStep(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_status (fmi2_import_t *fmu, const fmi2_status_kind_t s, fmi2_status_t *value)
 Wrapper for the FMI function fmiGetStatus(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_real_status (fmi2_import_t *fmu, const fmi2_status_kind_t s, fmi2_real_t *value)
 Wrapper for the FMI function fmiGetRealStatus(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_integer_status (fmi2_import_t *fmu, const fmi2_status_kind_t s, fmi2_integer_t *value)
 Wrapper for the FMI function fmiGetIntegerStatus(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_boolean_status (fmi2_import_t *fmu, const fmi2_status_kind_t s, fmi2_boolean_t *value)
 Wrapper for the FMI function fmiGetBooleanStatus(...) More...
 
FMILIB_EXPORT fmi2_status_t fmi2_import_get_string_status (fmi2_import_t *fmu, const fmi2_status_kind_t s, fmi2_string_t *value)
 Wrapper for the FMI function fmiGetStringStatus(...) More...
 

Detailed Description

Wrapper functions for the FMI 2.0 functions

Definition in file fmi2_import_capi.h.