--- /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>.
+*/
+
+
+#ifndef FMI1_CAPI_H_
+#define FMI1_CAPI_H_
+
+#include <FMI1/fmi1_types.h>
+#include <FMI1/fmi1_functions.h>
+#include <FMI1/fmi1_enums.h>
+#include <JM/jm_portability.h>
+#include <JM/jm_callbacks.h>
+\r
+typedef struct fmi1_capi_t fmi1_capi_t;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** \file fmi1_capi.h
+ \brief Public interfaces for the FMI CAPI library.
+ */
+
+/** \addtogroup fmi1_capi Standard FMI 1.0 "C" API\r
+ * \brief The "C" API loads and frees the FMI functions and it is through theise functions all the communcation with the FMU occures. The FMI import library wrappes these functions in a more convenient way.\r
+ * @{\r
+ */
+
+/** \addtogroup fmi1_capi_const_destroy FMI 1.0 Utility functions\r
+ * \brief Utility functions used to load and free the FMI functions.\r
+ * \addtogroup fmi1_capi_me FMI 1.0 (ME) Model Exchange functions\r
+ * \brief List of Model Exchange wrapper functions. Common functions are not listed.\r
+ * \addtogroup fmi1_capi_cs FMI 1.0 (CS) Co-Simulation functions \r
+ * \brief List of Co-Simulation wrapper functions. Common functions are not listed.\r
+ * \addtogroup fmi1_capi_common FMI 1.0 (ME & CS) Common functions\r
+ * \brief List of wrapper functions that are in common for both Model Exchange and Co-Simulation.\r
+ */
+
+
+/** \addtogroup fmi1_capi_const_destroy\r
+ * @{\r
+ */
+
+/**\r
+ * \brief Free a C-API struct. All memory allocated since the struct was created is freed.\r
+ * \r
+ * @param fmu A model description object returned by fmi1_import_allocate.\r
+ */
+void fmi1_capi_destroy_dllfmu(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Create a C-API struct. The C-API struct is a placeholder for the FMI DLL functions.\r
+ * \r
+ * @param callbacks ::jm_callbacks used to construct library objects.\r
+ * @param dllPath Full path to the FMU shared library.\r
+ * @param modelIdentifier The model indentifier.\r
+ * @param standard FMI standard that the function should load.\r
+ * @param callBackFunctions callbacks passed to the FMU.\r
+ * @return Error status. If the function returns with an error, it is not allowed to call any of the other C-API functions.\r
+ */
+fmi1_capi_t* fmi1_capi_create_dllfmu(jm_callbacks* callbacks, const char* dllPath, const char* modelIdentifier, fmi1_callback_functions_t callBackFunctions, fmi1_fmu_kind_enu_t standard);
+
+/**\r
+ * \brief Loads the FMI functions from the shared library. The shared library must be loaded before this function can be called, see fmi1_import_create_dllfmu().\r
+ * \r
+ * @param fmu A model description object returned by fmi1_import_allocate.\r
+ * @return Error status. If the function returns with an error, no other C-API functions than fmi1_import_free_dll and fmi1_import_destroy_dllfmu are allowed to be called.\r
+ */
+jm_status_enu_t fmi1_capi_load_fcn(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Loads the FMU´s shared library. The shared library functions are not loaded in this call, see fmi1_import_create_dllfmu.\r
+ * \r
+ * @param fmu A model description object returned by fmi1_import_allocate.\r
+ * @return Error status. If the function returns with an error, no other C-API functions than fmi1_import_destroy_dllfmu are allowed to be called.\r
+ */
+jm_status_enu_t fmi1_capi_load_dll(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Frees the handle to the FMU´s shared library. After this function returnes, no other C-API functions than fmi1_import_destroy_dllfmu and fmi1_import_create_dllfmu are allowed to be called.\r
+ * \r
+ * @param fmu A model description object returned by fmi1_import_allocate that has loaded the FMU´s shared library, see fmi1_import_load_dll.\r
+ * @return Error status.\r
+ */
+jm_status_enu_t fmi1_capi_free_dll(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Set CAPI debug mode flag. Setting to non-zero prevents DLL unloading in fmi1_capi_free_dll\r
+ * while all the memory is deallocated. This is to support valgrind debugging. \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param mode The debug mode to set.\r
+ */\r
+void fmi1_capi_set_debug_mode(fmi1_capi_t* fmu, int mode);
+
+/**\r
+ * \brief Get CAPI debug mode flag that was set with fmi1_capi_set_debug_mode()\r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function. */\r
+int fmi1_capi_get_debug_mode(fmi1_capi_t* fmu);
+
+
+/**@} */
+
+/** \addtogroup fmi1_capi_common\r
+ * @{\r
+ */
+
+/**\r
+ * \brief Calls the FMI function fmiGetVersion() \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @return FMI version.\r
+ */
+const char* fmi1_capi_get_version(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Calls the FMI function fmiSetDebugLogging(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param loggingOn Enable or disable the debug logger.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_debug_logging(fmi1_capi_t* fmu, fmi1_boolean_t loggingOn);
+
+/**\r
+ * \brief Calls the FMI function fmiSetReal(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_real(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_real_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiSetInteger(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_integer(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiSetBoolean(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_boolean(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_boolean_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiSetString(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_string(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_string_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiGetReal(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value (Output)Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_real(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_real_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiGetInteger(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value (Output)Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_integer(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_integer_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiGetBoolean(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value (Output)Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_boolean(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_boolean_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiGetString(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param value (Output)Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_string(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_string_t value[]);
+
+/**@} */
+
+/** \addtogroup fmi1_capi_me\r
+ * @{\r
+ */
+
+/**\r
+ * \brief Calls the FMI function fmiGetModelTypesPlatform(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @return The platform the FMU was compiled for.\r
+ */
+const char* fmi1_capi_get_model_types_platform(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Calls the FMI function fmiInstantiateModel(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param instanceName The name of the instance.\r
+ * @param GUID The GUID identifier.\r
+ * @param loggingOn Enable or disable the debug logger.\r
+ * @return An instance of a model.\r
+ */
+fmi1_component_t fmi1_capi_instantiate_model(fmi1_capi_t* fmu, fmi1_string_t instanceName, fmi1_string_t GUID, fmi1_boolean_t loggingOn);
+
+/**\r
+ * \brief Calls the FMI function fmiFreeModelInstance(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ */
+void fmi1_capi_free_model_instance(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Calls the FMI function fmiSetTime(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param time Set the current time.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_time(fmi1_capi_t* fmu, fmi1_real_t time);
+
+/**\r
+ * \brief Calls the FMI function fmiSetContinuousStates(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param x Array of state values.\r
+ * @param nx Number of states.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_continuous_states(fmi1_capi_t* fmu, const fmi1_real_t x[], size_t nx);
+
+/**\r
+ * \brief Calls the FMI function fmiCompletedIntegratorStep(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param callEventUpdate (Output) Call fmiEventUpdate indicator.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_completed_integrator_step(fmi1_capi_t* fmu, fmi1_boolean_t* callEventUpdate);
+
+/**\r
+ * \brief Calls the FMI function fmiInitialize(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param toleranceControlled Enable or disable the use of relativeTolerance in the FMU.\r
+ * @param relativeTolerance A relative tolerance used in the FMU.\r
+ * @param eventInfo (Output) fmiEventInfo struct.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_initialize(fmi1_capi_t* fmu, fmi1_boolean_t toleranceControlled, fmi1_real_t relativeTolerance, fmi1_event_info_t* eventInfo);
+
+/**\r
+ * \brief Calls the FMI function fmiGetDerivatives(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param derivatives (Output) Array of the derivatives.\r
+ * @param nx Number of derivatives.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_derivatives(fmi1_capi_t* fmu, fmi1_real_t derivatives[] , size_t nx);
+
+/**\r
+ * \brief Calls the FMI function fmiGetEventIndicators(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param eventIndicators (Output) The event indicators.\r
+ * @param ni Number of event indicators.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_event_indicators(fmi1_capi_t* fmu, fmi1_real_t eventIndicators[], size_t ni);
+
+/**\r
+ * \brief Calls the FMI function fmiEventUpdate(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param intermediateResults Indicate whether or not the fmiEventUpdate shall return after every internal event interation.\r
+ * @param eventInfo (Output) An fmiEventInfo struct.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_eventUpdate(fmi1_capi_t* fmu, fmi1_boolean_t intermediateResults, fmi1_event_info_t* eventInfo);
+
+/**\r
+ * \brief Calls the FMI function fmiGetContinuousStates(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param states (Output) Array of state values.\r
+ * @param nx Number of states.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_continuous_states(fmi1_capi_t* fmu, fmi1_real_t states[], size_t nx);
+
+/**\r
+ * \brief Calls the FMI function fmiGetNominalContinuousStates(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param x_nominal (Output) The nominal values.\r
+ * @param nx Number of nominal values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_nominal_continuous_states(fmi1_capi_t* fmu, fmi1_real_t x_nominal[], size_t nx);
+
+/**\r
+ * \brief Calls the FMI function fmiGetStateValueReferences(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vrx (Output) The value-references of the states.\r
+ * @param nx Number of value-references.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_state_value_references(fmi1_capi_t* fmu, fmi1_value_reference_t vrx[], size_t nx);
+
+/**\r
+ * \brief Calls the FMI function fmiTerminate(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_terminate(fmi1_capi_t* fmu);
+
+/**@} */
+
+/** \addtogroup fmi1_capi_cs\r
+ * @{\r
+ */
+
+/**\r
+ * \brief Calls the FMI function fmiGetTypesPlatform(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @return The platform the FMU was compiled for.\r
+ */
+const char* fmi1_capi_get_types_platform(fmi1_capi_t* fmu);
+/**\r
+ * \brief Calls the FMI function fmiInstantiateSlave(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param instanceName The name of the instance.\r
+ * @param fmuGUID The GUID identifier.\r
+ * @param fmuLocation Access path to the FMU archive.\r
+ * @param mimeType MIME type.\r
+ * @param timeout Communication timeout value in milli-seconds.\r
+ * @param visible Indicates whether or not the simulator application window shoule be visible.\r
+ * @param interactive Indicates whether the simulator application must be manually started by the user.\r
+ * @param loggingOn Enable or disable the debug logger.\r
+ * @return An instance of a model.\r
+ */
+fmi1_component_t fmi1_capi_instantiate_slave(fmi1_capi_t* fmu, 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_boolean_t loggingOn);
+/**\r
+ * \brief Calls the FMI function fmiInitializeSlave(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param tStart Start time of the simulation\r
+ * @param StopTimeDefined Indicates whether or not the stop time is used.\r
+ * @param tStop The stop time of the simulation.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_initialize_slave(fmi1_capi_t* fmu, fmi1_real_t tStart, fmi1_boolean_t StopTimeDefined, fmi1_real_t tStop);
+
+/**\r
+ * \brief Calls the FMI function fmiTerminateSlave(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_terminate_slave(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Calls the FMI function fmiResetSlave(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_reset_slave(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Calls the FMI function fmiFreeSlaveInstance(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ */
+void fmi1_capi_free_slave_instance(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Calls the FMI function fmiSetRealInputDerivatives(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully load the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param order Array of derivative orders.\r
+ * @param value Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_set_real_input_derivatives(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], const fmi1_real_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiGetOutputDerivatives(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param vr Array of value references.\r
+ * @param nvr Number of array elements.\r
+ * @param order Array of derivative orders.\r
+ * @param value (Output) Array of variable values.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_real_output_derivatives(fmi1_capi_t* fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], fmi1_real_t value[]);
+
+/**\r
+ * \brief Calls the FMI function fmiCancelStep(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_cancel_step(fmi1_capi_t* fmu);
+
+/**\r
+ * \brief Calls the FMI function fmiDoStep(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param currentCommunicationPoint Current communication point of the master.\r
+ * @param communicationStepSize Communication step size.\r
+ * @param newStep Indicates whether or not the last communication step was accepted by the master.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_do_step(fmi1_capi_t* fmu, fmi1_real_t currentCommunicationPoint, fmi1_real_t communicationStepSize, fmi1_boolean_t newStep);
+
+/**\r
+ * \brief Calls the FMI function fmiGetStatus(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param s Kind of status to return the value for.\r
+ * @param value (Output) FMI status value.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_status(fmi1_capi_t* fmu, const fmi1_status_kind_t s, fmi1_status_t* value);
+
+/**\r
+ * \brief Calls the FMI function fmiGetRealStatus(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param s Kind of status to return the value for.\r
+ * @param value (Output) FMI real value.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_real_status(fmi1_capi_t* fmu, const fmi1_status_kind_t s, fmi1_real_t* value);
+\r
+/**\r
+ * \brief Calls the FMI function fmiGetIntegerStatus(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param s Kind of status to return the value for.\r
+ * @param value (Output) FMI integer value.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_integer_status(fmi1_capi_t* fmu, const fmi1_status_kind_t s, fmi1_integer_t* value);
+
+/**\r
+ * \brief Calls the FMI function fmiGetBooleanStatus(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param s Kind of status to return the value for.\r
+ * @param value (Output) FMI boolean value.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_boolean_status(fmi1_capi_t* fmu, const fmi1_status_kind_t s, fmi1_boolean_t* value);
+
+/**\r
+ * \brief Calls the FMI function fmiGetStringStatus(...) \r
+ * \r
+ * @param fmu C-API struct that has succesfully loaded the FMI function.\r
+ * @param s Kind of status to return the value for.\r
+ * @param value (Output) FMI string value.\r
+ * @return FMI status.\r
+ */
+fmi1_status_t fmi1_capi_get_string_status(fmi1_capi_t* fmu, const fmi1_status_kind_t s, fmi1_string_t* value);
+
+/** @}*/
+/** @}*/
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* End of header file FMI1_CAPI_H_ */
Code Review / simantics / fmil.git / blobdiff