FMI Library: part of JModelica.org
Modules | Data Structures | Typedefs | Enumerations | Functions
Functions and types supporting FMI 2.0 processing.

Modules

 Enum types used with FMI 2.0 libs
 
 Definition of XML callbacks struct
 

Data Structures

struct  fmi2_callback_functions_t
 
struct  fmi2_event_info_t
 

Typedefs

typedef void(* fmi2_callback_logger_ft) (fmi2_component_environment_t env, fmi2_string_t instanceName, fmi2_status_t status, fmi2_string_t category, fmi2_string_t message,...)
 
typedef void *(* fmi2_callback_allocate_memory_ft) (size_t nobj, size_t size)
 
typedef void(* fmi2_callback_free_memory_ft) (void *obj)
 
typedef void(* fmi2_step_finished_ft) (fmi2_component_environment_t env, fmi2_status_t status)
 
typedef const char *(* fmi2_get_types_platform_ft) ()
 
typedef const char *(* fmi2_get_version_ft) ()
 
typedef fmi2_status_t(* fmi2_set_debug_logging_ft) (fmi2_component_t, fmi2_boolean_t, size_t nCategories, const fmi2_string_t categories[])
 
typedef fmi2_component_t(* fmi2_instantiate_ft) (fmi2_string_t, fmi2_type_t, fmi2_string_t, fmi2_string_t, const fmi2_callback_functions_t *, fmi2_boolean_t, fmi2_boolean_t)
 
typedef void(* fmi2_free_instance_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_setup_experiment_ft) (fmi2_component_t, fmi2_boolean_t, fmi2_real_t, fmi2_real_t, fmi2_boolean_t, fmi2_real_t)
 
typedef fmi2_status_t(* fmi2_enter_initialization_mode_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_exit_initialization_mode_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_terminate_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_reset_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_get_real_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_real_t[])
 
typedef fmi2_status_t(* fmi2_get_integer_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_integer_t[])
 
typedef fmi2_status_t(* fmi2_get_boolean_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_boolean_t[])
 
typedef fmi2_status_t(* fmi2_get_string_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_string_t[])
 
typedef fmi2_status_t(* fmi2_set_real_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_real_t[])
 
typedef fmi2_status_t(* fmi2_set_integer_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_integer_t[])
 
typedef fmi2_status_t(* fmi2_set_boolean_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_boolean_t[])
 
typedef fmi2_status_t(* fmi2_set_string_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_string_t[])
 
typedef fmi2_status_t(* fmi2_get_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t *)
 
typedef fmi2_status_t(* fmi2_set_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t)
 
typedef fmi2_status_t(* fmi2_free_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t *)
 
typedef fmi2_status_t(* fmi2_serialized_fmu_state_size_ft) (fmi2_component_t, fmi2_FMU_state_t, size_t *)
 
typedef fmi2_status_t(* fmi2_serialize_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t, fmi2_byte_t[], size_t)
 
typedef fmi2_status_t(* fmi2_de_serialize_fmu_state_ft) (fmi2_component_t, const fmi2_byte_t[], size_t, fmi2_FMU_state_t *)
 
typedef fmi2_status_t(* fmi2_get_directional_derivative_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_value_reference_t[], size_t, const fmi2_real_t[], fmi2_real_t[])
 
typedef fmi2_status_t(* fmi2_enter_event_mode_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_new_discrete_states_ft) (fmi2_component_t, fmi2_event_info_t *)
 
typedef fmi2_status_t(* fmi2_enter_continuous_time_mode_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_completed_integrator_step_ft) (fmi2_component_t, fmi2_boolean_t, fmi2_boolean_t *, fmi2_boolean_t *)
 
typedef fmi2_status_t(* fmi2_set_time_ft) (fmi2_component_t, fmi2_real_t)
 
typedef fmi2_status_t(* fmi2_set_continuous_states_ft) (fmi2_component_t, const fmi2_real_t[], size_t)
 
typedef fmi2_status_t(* fmi2_get_derivatives_ft) (fmi2_component_t, fmi2_real_t[], size_t)
 
typedef fmi2_status_t(* fmi2_get_event_indicators_ft) (fmi2_component_t, fmi2_real_t[], size_t)
 
typedef fmi2_status_t(* fmi2_get_continuous_states_ft) (fmi2_component_t, fmi2_real_t[], size_t)
 
typedef fmi2_status_t(* fmi2_get_nominals_of_continuous_states_ft) (fmi2_component_t, fmi2_real_t[], size_t)
 
typedef fmi2_status_t(* fmi2_set_real_input_derivatives_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_integer_t[], const fmi2_real_t[])
 
typedef fmi2_status_t(* fmi2_get_real_output_derivatives_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_integer_t[], fmi2_real_t[])
 
typedef fmi2_status_t(* fmi2_do_step_ft) (fmi2_component_t, fmi2_real_t, fmi2_real_t, fmi2_boolean_t)
 
typedef fmi2_status_t(* fmi2_cancel_step_ft) (fmi2_component_t)
 
typedef fmi2_status_t(* fmi2_get_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_status_t *)
 
typedef fmi2_status_t(* fmi2_get_real_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_real_t *)
 
typedef fmi2_status_t(* fmi2_get_integer_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_integer_t *)
 
typedef fmi2_status_t(* fmi2_get_boolean_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_boolean_t *)
 
typedef fmi2_status_t(* fmi2_get_string_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_string_t *)
 

Enumerations

enum  fmi2_status_t {
  fmi2_status_ok, fmi2_status_warning, fmi2_status_discard, fmi2_status_error,
  fmi2_status_fatal, fmi2_status_pending
}
 
enum  fmi2_type_t { fmi2_model_exchange, fmi2_cosimulation }
 
enum  fmi2_status_kind_t { fmi2_do_step_status, fmi2_pending_status, fmi2_last_successful_time, fmi2_terminated }
 
enum  fmi2_boolean_enu_t { fmi2_true =fmi2True, fmi2_false =fmi2False }
 

Functions

FMILIB_EXPORT const charfmi2_status_to_string (fmi2_status_t status)
 
static const charfmi2_get_types_platform (void)
 

Renaming of typedefs

#define fmi2Component   fmi2_component_t
 
#define fmi2ComponentEnvironment   fmi2_component_environment_t
 
#define fmi2FMUstate   fmi2_FMU_state_t
 
#define fmi2ValueReference   fmi2_value_reference_t
 
#define fmi2Real   fmi2_real_t
 
#define fmi2Integer   fmi2_integer_t
 
#define fmi2Boolean   fmi2_boolean_t
 
#define fmi2Char   fmi2_char_t
 
#define fmi2String   fmi2_string_t
 
#define fmi2Byte   fmi2_byte_t
 

Detailed Description

Macro Definition Documentation

#define fmi2Component   fmi2_component_t

Definition at line 33 of file fmi2_types.h.

#define fmi2ComponentEnvironment   fmi2_component_environment_t

Definition at line 34 of file fmi2_types.h.

#define fmi2FMUstate   fmi2_FMU_state_t

Definition at line 35 of file fmi2_types.h.

#define fmi2ValueReference   fmi2_value_reference_t

Definition at line 36 of file fmi2_types.h.

#define fmi2Real   fmi2_real_t

Definition at line 37 of file fmi2_types.h.

#define fmi2Integer   fmi2_integer_t

Definition at line 38 of file fmi2_types.h.

#define fmi2Boolean   fmi2_boolean_t

Definition at line 39 of file fmi2_types.h.

#define fmi2Char   fmi2_char_t

Definition at line 40 of file fmi2_types.h.

#define fmi2String   fmi2_string_t

Definition at line 41 of file fmi2_types.h.

#define fmi2Byte   fmi2_byte_t

Definition at line 42 of file fmi2_types.h.

Typedef Documentation

typedef void(* fmi2_callback_logger_ft) (fmi2_component_environment_t env, fmi2_string_t instanceName, fmi2_status_t status, fmi2_string_t category, fmi2_string_t message,...)

FMI 2.0 logger function type

Definition at line 61 of file fmi2_functions.h.

typedef void*(* fmi2_callback_allocate_memory_ft) (size_t nobj, size_t size)

FMI 2.0 allocate memory function type

Definition at line 63 of file fmi2_functions.h.

typedef void(* fmi2_callback_free_memory_ft) (void *obj)

FMI 2.0 free memory function type

Definition at line 65 of file fmi2_functions.h.

typedef void(* fmi2_step_finished_ft) (fmi2_component_environment_t env, fmi2_status_t status)

FMI 2.0 step finished callback function type

Definition at line 67 of file fmi2_functions.h.

typedef const char*(* fmi2_get_types_platform_ft) ()

Definition at line 112 of file fmi2_functions.h.

typedef const char*(* fmi2_get_version_ft) ()

Definition at line 113 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_debug_logging_ft) (fmi2_component_t, fmi2_boolean_t, size_t nCategories, const fmi2_string_t categories[])

Definition at line 114 of file fmi2_functions.h.

typedef fmi2_component_t(* fmi2_instantiate_ft) (fmi2_string_t, fmi2_type_t, fmi2_string_t, fmi2_string_t, const fmi2_callback_functions_t *, fmi2_boolean_t, fmi2_boolean_t)

Definition at line 117 of file fmi2_functions.h.

typedef void(* fmi2_free_instance_ft) (fmi2_component_t)

Definition at line 118 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_setup_experiment_ft) (fmi2_component_t, fmi2_boolean_t, fmi2_real_t, fmi2_real_t, fmi2_boolean_t, fmi2_real_t)

Definition at line 121 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_enter_initialization_mode_ft) (fmi2_component_t)

Definition at line 122 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_exit_initialization_mode_ft) (fmi2_component_t)

Definition at line 123 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_terminate_ft) (fmi2_component_t)

Definition at line 124 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_reset_ft) (fmi2_component_t)

Definition at line 125 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_real_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_real_t[])

Definition at line 128 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_integer_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_integer_t[])

Definition at line 129 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_boolean_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_boolean_t[])

Definition at line 130 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_string_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, fmi2_string_t[])

Definition at line 131 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_real_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_real_t[])

Definition at line 133 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_integer_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_integer_t[])

Definition at line 134 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_boolean_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_boolean_t[])

Definition at line 135 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_string_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_string_t[])

Definition at line 136 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t *)

Definition at line 139 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t)

Definition at line 140 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_free_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t *)

Definition at line 141 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_serialized_fmu_state_size_ft) (fmi2_component_t, fmi2_FMU_state_t, size_t *)

Definition at line 142 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_serialize_fmu_state_ft) (fmi2_component_t, fmi2_FMU_state_t, fmi2_byte_t[], size_t)

Definition at line 143 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_de_serialize_fmu_state_ft) (fmi2_component_t, const fmi2_byte_t[], size_t, fmi2_FMU_state_t *)

Definition at line 144 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_directional_derivative_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_value_reference_t[], size_t, const fmi2_real_t[], fmi2_real_t[])

Definition at line 147 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_enter_event_mode_ft) (fmi2_component_t)

Definition at line 156 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_new_discrete_states_ft) (fmi2_component_t, fmi2_event_info_t *)

Definition at line 157 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_enter_continuous_time_mode_ft) (fmi2_component_t)

Definition at line 158 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_completed_integrator_step_ft) (fmi2_component_t, fmi2_boolean_t, fmi2_boolean_t *, fmi2_boolean_t *)

Definition at line 159 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_time_ft) (fmi2_component_t, fmi2_real_t)

Definition at line 162 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_continuous_states_ft) (fmi2_component_t, const fmi2_real_t[], size_t)

Definition at line 163 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_derivatives_ft) (fmi2_component_t, fmi2_real_t[], size_t)

Definition at line 166 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_event_indicators_ft) (fmi2_component_t, fmi2_real_t[], size_t)

Definition at line 167 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_continuous_states_ft) (fmi2_component_t, fmi2_real_t[], size_t)

Definition at line 168 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_nominals_of_continuous_states_ft) (fmi2_component_t, fmi2_real_t[], size_t)

Definition at line 169 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_set_real_input_derivatives_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_integer_t[], const fmi2_real_t[])

Definition at line 177 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_real_output_derivatives_ft) (fmi2_component_t, const fmi2_value_reference_t[], size_t, const fmi2_integer_t[], fmi2_real_t[])

Definition at line 178 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_do_step_ft) (fmi2_component_t, fmi2_real_t, fmi2_real_t, fmi2_boolean_t)

Definition at line 180 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_cancel_step_ft) (fmi2_component_t)

Definition at line 181 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_status_t *)

Definition at line 184 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_real_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_real_t *)

Definition at line 185 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_integer_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_integer_t *)

Definition at line 186 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_boolean_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_boolean_t *)

Definition at line 187 of file fmi2_functions.h.

typedef fmi2_status_t(* fmi2_get_string_status_ft) (fmi2_component_t, const fmi2_status_kind_t, fmi2_string_t *)

Definition at line 188 of file fmi2_functions.h.

Enumeration Type Documentation

FMI 2.0 status codes

Enumerator
fmi2_status_ok 
fmi2_status_warning 
fmi2_status_discard 
fmi2_status_error 
fmi2_status_fatal 
fmi2_status_pending 

Definition at line 40 of file fmi2_functions.h.

Enumerator
fmi2_model_exchange 
fmi2_cosimulation 

Definition at line 49 of file fmi2_functions.h.

Co-simulation status for FMI 2.0 CS

Enumerator
fmi2_do_step_status 
fmi2_pending_status 
fmi2_last_successful_time 
fmi2_terminated 

Definition at line 91 of file fmi2_functions.h.

FMI boolean constants.

Enumerator
fmi2_true 
fmi2_false 

Definition at line 60 of file fmi2_types.h.

Function Documentation

FMILIB_EXPORT const char* fmi2_status_to_string ( fmi2_status_t  status)

Convert fmi2_status_t variable to string

static const char* fmi2_get_types_platform ( void  )
static

FMI platform name constant string.

Definition at line 53 of file fmi2_types.h.