--- /dev/null
+/*
+ Copyright (C) 2012 Modelon AB
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the BSD style license.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ FMILIB_License.txt file for more details.
+
+ You should have received a copy of the FMILIB_License.txt file
+ along with this program. If not, contact Modelon AB <http://www.modelon.com>.
+*/\r
+\r
+#ifndef FMI1_FUNCTIONS_H_\r
+#define FMI1_FUNCTIONS_H_\r
+\r
+#include <fmilib_config.h>\r
+\r
+#include "fmi1_types.h"\r
+#include <string.h>\r
+/** \file fmi1_functions.h\r
+ Mapping for the standard FMI 1.0 functions into fmi1_ namespace.\r
+\r
+ \addtogroup fmi1_utils\r
+ @{\r
+*/
+\r
+/** FMI 1.0 status codes */\r
+typedef enum {\r
+ fmi1_status_ok,\r
+ fmi1_status_warning,\r
+ fmi1_status_discard,\r
+ fmi1_status_error,\r
+ fmi1_status_fatal,\r
+ fmi1_status_pending\r
+} fmi1_status_t;\r
+\r
+/** Convert #fmi1_status_t variable to string */\r
+FMILIB_EXPORT const char* fmi1_status_to_string(fmi1_status_t status);\r
+\r
+/** FMI 1.0 logger function type */\r
+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, ...);\r
+/** FMI 1.0 allocate memory function type */\r
+typedef void* (*fmi1_callback_allocate_memory_ft)(size_t nobj, size_t size);\r
+/** FMI 1.0 free memory function type */\r
+typedef void (*fmi1_callback_free_memory_ft) (void* obj);\r
+/** FMI 1.0 step finished callback function type */\r
+typedef void (*fmi1_step_finished_ft) (fmi1_component_t c, fmi1_status_t status);\r
+\r
+/** Functions for FMI 1.0 ME */\r
+typedef struct {\r
+ fmi1_callback_logger_ft logger;\r
+ fmi1_callback_allocate_memory_ft allocateMemory;\r
+ fmi1_callback_free_memory_ft freeMemory;\r
+} fmi1_me_callback_functions_t;\r
+\r
+/** The FMI 1.0 CS strcuture adds one field to the ME, otherwize compatible */\r
+typedef struct {\r
+ fmi1_callback_logger_ft logger;\r
+ fmi1_callback_allocate_memory_ft allocateMemory;\r
+ fmi1_callback_free_memory_ft freeMemory;\r
+ fmi1_step_finished_ft stepFinished;\r
+} fmi1_callback_functions_t;\r
+\r
+/** Event info structure as used in FMI 1.0 ME */\r
+typedef struct {\r
+ fmi1_boolean_t iterationConverged;\r
+ fmi1_boolean_t stateValueReferencesChanged;\r
+ fmi1_boolean_t stateValuesChanged;\r
+ fmi1_boolean_t terminateSimulation;\r
+ fmi1_boolean_t upcomingTimeEvent;\r
+ fmi1_real_t nextEventTime;\r
+} fmi1_event_info_t;\r
+\r
+/** FMI 1.0 asyncronous co-simulation status */\r
+typedef enum {\r
+ fmi1_do_step_status,\r
+ fmi1_pending_status,\r
+ fmi1_last_successful_time\r
+} fmi1_status_kind_t;\r
+\r
+/* FMI 1.0 common functions */\r
+typedef const char* (*fmi1_get_version_ft) (void);\r
+typedef fmi1_status_t (*fmi1_set_debug_logging_ft) (fmi1_component_t c, fmi1_boolean_t loggingOn);\r
+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[]);\r
+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[]);\r
+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[]);\r
+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[]);\r
+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[]);\r
+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[]);\r
+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[]);\r
+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[]);\r
+\r
+/* FMI ME 1.0 functions */\r
+typedef const char* (*fmi1_get_model_typesPlatform_ft) (void);\r
+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);\r
+typedef void (*fmi1_free_model_instance_ft) (fmi1_component_t c);\r
+typedef fmi1_status_t (*fmi1_set_time_ft) (fmi1_component_t c, fmi1_real_t time);\r
+typedef fmi1_status_t (*fmi1_set_continuous_states_ft) (fmi1_component_t c, const fmi1_real_t x[], size_t nx);\r
+typedef fmi1_status_t (*fmi1_completed_integrator_step_ft) (fmi1_component_t c, fmi1_boolean_t* callEventUpdate);\r
+typedef fmi1_status_t (*fmi1_initialize_ft) (fmi1_component_t c, fmi1_boolean_t toleranceControlled, fmi1_real_t relativeTolerance, fmi1_event_info_t* eventInfo);\r
+typedef fmi1_status_t (*fmi1_get_derivatives_ft) (fmi1_component_t c, fmi1_real_t derivatives[] , size_t nx);\r
+typedef fmi1_status_t (*fmi1_get_event_indicators_ft) (fmi1_component_t c, fmi1_real_t eventIndicators[], size_t ni);\r
+typedef fmi1_status_t (*fmi1_event_update_ft) (fmi1_component_t c, fmi1_boolean_t intermediateResults, fmi1_event_info_t* eventInfo);\r
+typedef fmi1_status_t (*fmi1_get_continuous_states_ft) (fmi1_component_t c, fmi1_real_t states[], size_t nx);\r
+typedef fmi1_status_t (*fmi1_get_nominal_continuousStates_ft) (fmi1_component_t c, fmi1_real_t x_nominal[], size_t nx);\r
+typedef fmi1_status_t (*fmi1_get_state_valueReferences_ft) (fmi1_component_t c, fmi1_value_reference_t vrx[], size_t nx);\r
+typedef fmi1_status_t (*fmi1_terminate_ft) (fmi1_component_t c); \r
+\r
+\r
+/* FMI CS 1.0 functions */\r
+typedef const char* (*fmi1_get_types_platform_ft) (void );\r
+typedef fmi1_component_t (*fmi1_instantiate_slave_ft) (fmi1_string_t instanceName, fmi1_string_t fmuGUID, fmi1_string_t fmuLocation, \r
+ fmi1_string_t mimeType, fmi1_real_t timeout, fmi1_boolean_t visible, fmi1_boolean_t interactive, \r
+ fmi1_callback_functions_t functions, fmi1_boolean_t loggingOn);\r
+typedef fmi1_status_t (*fmi1_initialize_slave_ft) (fmi1_component_t c, fmi1_real_t tStart, fmi1_boolean_t StopTimeDefined, fmi1_real_t tStop);\r
+typedef fmi1_status_t (*fmi1_terminate_slave_ft) (fmi1_component_t c);\r
+typedef fmi1_status_t (*fmi1_reset_slave_ft) (fmi1_component_t c);\r
+typedef void (*fmi1_free_slave_instance_ft) (fmi1_component_t c);\r
+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[]); \r
+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[]); \r
+typedef fmi1_status_t (*fmi1_cancel_step_ft) (fmi1_component_t c);\r
+typedef fmi1_status_t (*fmi1_do_step_ft) (fmi1_component_t c, fmi1_real_t currentCommunicationPoint, fmi1_real_t communicationStepSize, fmi1_boolean_t newStep);\r
+\r
+typedef fmi1_status_t (*fmi1_get_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_status_t* value);\r
+typedef fmi1_status_t (*fmi1_get_real_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_real_t* value);\r
+typedef fmi1_status_t (*fmi1_get_integer_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_integer_t* value);\r
+typedef fmi1_status_t (*fmi1_get_boolean_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_boolean_t* value);\r
+typedef fmi1_status_t (*fmi1_get_string_status_ft) (fmi1_component_t c, const fmi1_status_kind_t s, fmi1_string_t* value); \r
+\r
+/** @}\r
+*/
+\r
+#endif /* End of header file FMI_FUNCTIONS_H_ */\r
Code Review / simantics / fmil.git / blobdiff