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

Modules

 Enum types used with FMI 1.0 libs
 

Data Structures

struct  fmi1_me_callback_functions_t
 
struct  fmi1_callback_functions_t
 
struct  fmi1_event_info_t
 

Typedefs

typedef void(* fmi1_callback_logger_ft) (fmi1_component_t c, fmi1_string_t instanceName, fmi1_status_t status, fmi1_string_t category, fmi1_string_t message,...)
 
typedef void *(* fmi1_callback_allocate_memory_ft) (size_t nobj, size_t size)
 
typedef void(* fmi1_callback_free_memory_ft) (void *obj)
 
typedef void(* fmi1_step_finished_ft) (fmi1_component_t c, fmi1_status_t status)
 
typedef const char *(* fmi1_get_version_ft) (void)
 
typedef fmi1_status_t(* fmi1_set_debug_logging_ft) (fmi1_component_t c, fmi1_boolean_t loggingOn)
 
typedef fmi1_status_t(* fmi1_set_real_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_real_t value[])
 
typedef fmi1_status_t(* fmi1_set_integer_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t value[])
 
typedef fmi1_status_t(* fmi1_set_boolean_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_boolean_t value[])
 
typedef fmi1_status_t(* fmi1_set_string_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_string_t value[])
 
typedef fmi1_status_t(* fmi1_get_real_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_real_t value[])
 
typedef fmi1_status_t(* fmi1_get_integer_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_integer_t value[])
 
typedef fmi1_status_t(* fmi1_get_boolean_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_boolean_t value[])
 
typedef fmi1_status_t(* fmi1_get_string_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_string_t value[])
 
typedef const char *(* fmi1_get_model_typesPlatform_ft) (void)
 
typedef fmi1_component_t(* fmi1_instantiate_model_ft) (fmi1_string_t instanceName, fmi1_string_t GUID, fmi1_me_callback_functions_t functions, fmi1_boolean_t loggingOn)
 
typedef void(* fmi1_free_model_instance_ft) (fmi1_component_t c)
 
typedef fmi1_status_t(* fmi1_set_time_ft) (fmi1_component_t c, fmi1_real_t time)
 
typedef fmi1_status_t(* fmi1_set_continuous_states_ft) (fmi1_component_t c, const fmi1_real_t x[], size_t nx)
 
typedef fmi1_status_t(* fmi1_completed_integrator_step_ft) (fmi1_component_t c, fmi1_boolean_t *callEventUpdate)
 
typedef fmi1_status_t(* fmi1_initialize_ft) (fmi1_component_t c, fmi1_boolean_t toleranceControlled, fmi1_real_t relativeTolerance, fmi1_event_info_t *eventInfo)
 
typedef fmi1_status_t(* fmi1_get_derivatives_ft) (fmi1_component_t c, fmi1_real_t derivatives[], size_t nx)
 
typedef fmi1_status_t(* fmi1_get_event_indicators_ft) (fmi1_component_t c, fmi1_real_t eventIndicators[], size_t ni)
 
typedef fmi1_status_t(* fmi1_event_update_ft) (fmi1_component_t c, fmi1_boolean_t intermediateResults, fmi1_event_info_t *eventInfo)
 
typedef fmi1_status_t(* fmi1_get_continuous_states_ft) (fmi1_component_t c, fmi1_real_t states[], size_t nx)
 
typedef fmi1_status_t(* fmi1_get_nominal_continuousStates_ft) (fmi1_component_t c, fmi1_real_t x_nominal[], size_t nx)
 
typedef fmi1_status_t(* fmi1_get_state_valueReferences_ft) (fmi1_component_t c, fmi1_value_reference_t vrx[], size_t nx)
 
typedef fmi1_status_t(* fmi1_terminate_ft) (fmi1_component_t c)
 
typedef const char *(* fmi1_get_types_platform_ft) (void)
 
typedef fmi1_component_t(* fmi1_instantiate_slave_ft) (fmi1_string_t instanceName, fmi1_string_t fmuGUID, fmi1_string_t fmuLocation, fmi1_string_t mimeType, fmi1_real_t timeout, fmi1_boolean_t visible, fmi1_boolean_t interactive, fmi1_callback_functions_t functions, fmi1_boolean_t loggingOn)
 
typedef fmi1_status_t(* fmi1_initialize_slave_ft) (fmi1_component_t c, fmi1_real_t tStart, fmi1_boolean_t StopTimeDefined, fmi1_real_t tStop)
 
typedef fmi1_status_t(* fmi1_terminate_slave_ft) (fmi1_component_t c)
 
typedef fmi1_status_t(* fmi1_reset_slave_ft) (fmi1_component_t c)
 
typedef void(* fmi1_free_slave_instance_ft) (fmi1_component_t c)
 
typedef fmi1_status_t(* fmi1_set_real_inputDerivatives_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], const fmi1_real_t value[])
 
typedef fmi1_status_t(* fmi1_get_real_outputDerivatives_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], fmi1_real_t value[])
 
typedef fmi1_status_t(* fmi1_cancel_step_ft) (fmi1_component_t c)
 
typedef fmi1_status_t(* fmi1_do_step_ft) (fmi1_component_t c, fmi1_real_t currentCommunicationPoint, fmi1_real_t communicationStepSize, fmi1_boolean_t newStep)
 
typedef fmi1_status_t(* fmi1_get_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_status_t *value)
 
typedef fmi1_status_t(* fmi1_get_real_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_real_t *value)
 
typedef fmi1_status_t(* fmi1_get_integer_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_integer_t *value)
 
typedef fmi1_status_t(* fmi1_get_boolean_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_boolean_t *value)
 
typedef fmi1_status_t(* fmi1_get_string_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_string_t *value)
 
typedef enum fmi1_value_reference_enu_t fmi1_value_reference_enu_t
 

Enumerations

enum  fmi1_status_t {
  fmi1_status_ok, fmi1_status_warning, fmi1_status_discard, fmi1_status_error,
  fmi1_status_fatal, fmi1_status_pending
}
 
enum  fmi1_status_kind_t { fmi1_do_step_status, fmi1_pending_status, fmi1_last_successful_time }
 
enum  fmi1_boolean_enu_t { fmi1_true =fmiTrue, fmi1_false =fmiFalse }
 
enum  fmi1_value_reference_enu_t { fmi1_undefined_value_reference = (int)fmiUndefinedValueReference }
 

Functions

FMILIB_EXPORT const charfmi1_status_to_string (fmi1_status_t status)
 
static const charfmi1_get_platform (void)
 

Renaming of typedefs

#define fmiComponent   fmi1_component_t
 
#define fmiValueReference   fmi1_value_reference_t
 
#define fmiReal   fmi1_real_t
 
#define fmiInteger   fmi1_integer_t
 
#define fmiBoolean   fmi1_boolean_t
 
#define fmiString   fmi1_string_t
 

Detailed Description

Macro Definition Documentation

#define fmiComponent   fmi1_component_t

Definition at line 33 of file fmi1_types.h.

#define fmiValueReference   fmi1_value_reference_t

Definition at line 34 of file fmi1_types.h.

#define fmiReal   fmi1_real_t

Definition at line 35 of file fmi1_types.h.

#define fmiInteger   fmi1_integer_t

Definition at line 36 of file fmi1_types.h.

#define fmiBoolean   fmi1_boolean_t

Definition at line 37 of file fmi1_types.h.

#define fmiString   fmi1_string_t

Definition at line 38 of file fmi1_types.h.

Typedef Documentation

typedef void(* fmi1_callback_logger_ft) (fmi1_component_t c, fmi1_string_t instanceName, fmi1_status_t status, fmi1_string_t category, fmi1_string_t message,...)

FMI 1.0 logger function type

Definition at line 44 of file fmi1_functions.h.

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

FMI 1.0 allocate memory function type

Definition at line 46 of file fmi1_functions.h.

typedef void(* fmi1_callback_free_memory_ft) (void *obj)

FMI 1.0 free memory function type

Definition at line 48 of file fmi1_functions.h.

typedef void(* fmi1_step_finished_ft) (fmi1_component_t c, fmi1_status_t status)

FMI 1.0 step finished callback function type

Definition at line 50 of file fmi1_functions.h.

typedef const char*(* fmi1_get_version_ft) (void)

Definition at line 85 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_debug_logging_ft) (fmi1_component_t c, fmi1_boolean_t loggingOn)

Definition at line 86 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_real_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_real_t value[])

Definition at line 87 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_integer_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t value[])

Definition at line 88 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_boolean_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_boolean_t value[])

Definition at line 89 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_string_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_string_t value[])

Definition at line 90 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_real_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_real_t value[])

Definition at line 91 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_integer_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_integer_t value[])

Definition at line 92 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_boolean_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_boolean_t value[])

Definition at line 93 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_string_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, fmi1_string_t value[])

Definition at line 94 of file fmi1_functions.h.

typedef const char*(* fmi1_get_model_typesPlatform_ft) (void)

Definition at line 97 of file fmi1_functions.h.

typedef fmi1_component_t(* fmi1_instantiate_model_ft) (fmi1_string_t instanceName, fmi1_string_t GUID, fmi1_me_callback_functions_t functions, fmi1_boolean_t loggingOn)

Definition at line 98 of file fmi1_functions.h.

typedef void(* fmi1_free_model_instance_ft) (fmi1_component_t c)

Definition at line 99 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_time_ft) (fmi1_component_t c, fmi1_real_t time)

Definition at line 100 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_continuous_states_ft) (fmi1_component_t c, const fmi1_real_t x[], size_t nx)

Definition at line 101 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_completed_integrator_step_ft) (fmi1_component_t c, fmi1_boolean_t *callEventUpdate)

Definition at line 102 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_initialize_ft) (fmi1_component_t c, fmi1_boolean_t toleranceControlled, fmi1_real_t relativeTolerance, fmi1_event_info_t *eventInfo)

Definition at line 103 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_derivatives_ft) (fmi1_component_t c, fmi1_real_t derivatives[], size_t nx)

Definition at line 104 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_event_indicators_ft) (fmi1_component_t c, fmi1_real_t eventIndicators[], size_t ni)

Definition at line 105 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_event_update_ft) (fmi1_component_t c, fmi1_boolean_t intermediateResults, fmi1_event_info_t *eventInfo)

Definition at line 106 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_continuous_states_ft) (fmi1_component_t c, fmi1_real_t states[], size_t nx)

Definition at line 107 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_nominal_continuousStates_ft) (fmi1_component_t c, fmi1_real_t x_nominal[], size_t nx)

Definition at line 108 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_state_valueReferences_ft) (fmi1_component_t c, fmi1_value_reference_t vrx[], size_t nx)

Definition at line 109 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_terminate_ft) (fmi1_component_t c)

Definition at line 110 of file fmi1_functions.h.

typedef const char*(* fmi1_get_types_platform_ft) (void)

Definition at line 114 of file fmi1_functions.h.

typedef fmi1_component_t(* fmi1_instantiate_slave_ft) (fmi1_string_t instanceName, fmi1_string_t fmuGUID, fmi1_string_t fmuLocation, fmi1_string_t mimeType, fmi1_real_t timeout, fmi1_boolean_t visible, fmi1_boolean_t interactive, fmi1_callback_functions_t functions, fmi1_boolean_t loggingOn)

Definition at line 115 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_initialize_slave_ft) (fmi1_component_t c, fmi1_real_t tStart, fmi1_boolean_t StopTimeDefined, fmi1_real_t tStop)

Definition at line 118 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_terminate_slave_ft) (fmi1_component_t c)

Definition at line 119 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_reset_slave_ft) (fmi1_component_t c)

Definition at line 120 of file fmi1_functions.h.

typedef void(* fmi1_free_slave_instance_ft) (fmi1_component_t c)

Definition at line 121 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_set_real_inputDerivatives_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], const fmi1_real_t value[])

Definition at line 122 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_real_outputDerivatives_ft) (fmi1_component_t c, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], fmi1_real_t value[])

Definition at line 123 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_cancel_step_ft) (fmi1_component_t c)

Definition at line 124 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_do_step_ft) (fmi1_component_t c, fmi1_real_t currentCommunicationPoint, fmi1_real_t communicationStepSize, fmi1_boolean_t newStep)

Definition at line 125 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_status_t *value)

Definition at line 127 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_real_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_real_t *value)

Definition at line 128 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_integer_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_integer_t *value)

Definition at line 129 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_boolean_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_boolean_t *value)

Definition at line 130 of file fmi1_functions.h.

typedef fmi1_status_t(* fmi1_get_string_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_string_t *value)

Definition at line 131 of file fmi1_functions.h.

Undefined value for fmiValueReference (largest unsigned int value)

Enumeration Type Documentation

FMI 1.0 status codes

Enumerator
fmi1_status_ok 
fmi1_status_warning 
fmi1_status_discard 
fmi1_status_error 
fmi1_status_fatal 
fmi1_status_pending 

Definition at line 31 of file fmi1_functions.h.

FMI 1.0 asyncronous co-simulation status

Enumerator
fmi1_do_step_status 
fmi1_pending_status 
fmi1_last_successful_time 

Definition at line 78 of file fmi1_functions.h.

FMI boolean constants.

Enumerator
fmi1_true 
fmi1_false 

Definition at line 55 of file fmi1_types.h.

Undefined value for fmiValueReference (largest unsigned int value)

Enumerator
fmi1_undefined_value_reference 

Definition at line 64 of file fmi1_types.h.

Function Documentation

FMILIB_EXPORT const char* fmi1_status_to_string ( fmi1_status_t  status)

Convert fmi1_status_t variable to string

static const char* fmi1_get_platform ( void  )
static

FMI platform name constant string.

Definition at line 48 of file fmi1_types.h.