org.simantics.fmil.core/native/FMILibrary/ThirdParty/FMI/default/FMI2/fmi2FunctionTypes.h

   1 #ifndef fmi2FunctionTypes_h\r
   2 #define fmi2FunctionTypes_h\r
   3 \r
   4 #include "fmi2TypesPlatform.h"\r
   5 \r
   6 /* This header file must be utilized when compiling an FMU or an FMI master.\r
   7    It declares data and function types for FMI 2.0\r
   8 \r
   9    Revisions:\r
  10    - Apr.  9, 2014: all prefixes "fmi" renamed to "fmi2" (decision from April 8)\r
  11    - Apr.  3, 2014: Added #include <stddef.h> for size_t definition\r
  12    - Mar. 27, 2014: Added #include "fmiTypesPlatform.h" (#179)\r
  13    - Mar. 26, 2014: Introduced function argument "void" for the functions (#171)\r
  14                       fmiGetTypesPlatformTYPE and fmiGetVersionTYPE\r
  15    - Oct. 11, 2013: Functions of ModelExchange and CoSimulation merged:\r
  16                       fmiInstantiateModelTYPE , fmiInstantiateSlaveTYPE  -> fmiInstantiateTYPE\r
  17                       fmiFreeModelInstanceTYPE, fmiFreeSlaveInstanceTYPE -> fmiFreeInstanceTYPE\r
  18                       fmiEnterModelInitializationModeTYPE, fmiEnterSlaveInitializationModeTYPE -> fmiEnterInitializationModeTYPE\r
  19                       fmiExitModelInitializationModeTYPE , fmiExitSlaveInitializationModeTYPE  -> fmiExitInitializationModeTYPE\r
  20                       fmiTerminateModelTYPE , fmiTerminateSlaveTYPE  -> fmiTerminate\r
  21                       fmiResetSlave -> fmiReset (now also for ModelExchange and not only for CoSimulation)\r
  22                     Functions renamed\r
  23                       fmiUpdateDiscreteStatesTYPE -> fmiNewDiscreteStatesTYPE\r
  24                     Renamed elements of the enumeration fmiEventInfo\r
  25                       upcomingTimeEvent             -> nextEventTimeDefined // due to generic naming scheme: varDefined + var\r
  26                       newUpdateDiscreteStatesNeeded -> newDiscreteStatesNeeded;\r
  27    - June 13, 2013: Changed type fmiEventInfo\r
  28                     Functions removed:\r
  29                        fmiInitializeModelTYPE\r
  30                        fmiEventUpdateTYPE\r
  31                        fmiCompletedEventIterationTYPE\r
  32                        fmiInitializeSlaveTYPE\r
  33                     Functions added:\r
  34                        fmiEnterModelInitializationModeTYPE\r
  35                        fmiExitModelInitializationModeTYPE\r
  36                        fmiEnterEventModeTYPE\r
  37                        fmiUpdateDiscreteStatesTYPE\r
  38                        fmiEnterContinuousTimeModeTYPE\r
  39                        fmiEnterSlaveInitializationModeTYPE;\r
  40                        fmiExitSlaveInitializationModeTYPE;\r
  41    - Feb. 17, 2013: Added third argument to fmiCompletedIntegratorStepTYPE\r
  42                     Changed function name "fmiTerminateType" to "fmiTerminateModelType" (due to #113)\r
  43                     Changed function name "fmiGetNominalContinuousStateTYPE" to\r
  44                                           "fmiGetNominalsOfContinuousStatesTYPE"\r
  45                     Removed fmiGetStateValueReferencesTYPE.\r
  46    - Nov. 14, 2011: First public Version\r
  47 \r
  48 \r
  49    Copyright © 2011 MODELISAR consortium,\r
  50                2012-2013 Modelica Association Project "FMI"\r
  51                All rights reserved.\r
  52    This file is licensed by the copyright holders under the BSD 2-Clause License\r
  53    (http://www.opensource.org/licenses/bsd-license.html):\r
  54 \r
  55    ----------------------------------------------------------------------------\r
  56    Redistribution and use in source and binary forms, with or without\r
  57    modification, are permitted provided that the following conditions are met:\r
  58 \r
  59    - Redistributions of source code must retain the above copyright notice,\r
  60      this list of conditions and the following disclaimer.\r
  61    - Redistributions in binary form must reproduce the above copyright notice,\r
  62      this list of conditions and the following disclaimer in the documentation\r
  63      and/or other materials provided with the distribution.\r
  64    - Neither the name of the copyright holders nor the names of its\r
  65      contributors may be used to endorse or promote products derived\r
  66      from this software without specific prior written permission.\r
  67 \r
  68    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
  69    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED\r
  70    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\r
  71    PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR\r
  72    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
  73    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\r
  74    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;\r
  75    OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
  76    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\r
  77    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF\r
  78    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  79    ----------------------------------------------------------------------------\r
  80 \r
  81    with the extension:\r
  82 \r
  83    You may distribute or publicly perform any modification only under the\r
  84    terms of this license.\r
  85    (Note, this means that if you distribute a modified file,\r
  86     the modified file must also be provided under this license).\r
  87 */\r
  88 \r
  89 #ifdef __cplusplus\r
  90 extern "C" {\r
  91 #endif\r
  92 \r
  93 /* make sure all compiler use the same alignment policies for structures */\r
  94 #if defined _MSC_VER || defined __GNUC__\r
  95 #pragma pack(push,8)\r
  96 #endif\r
  97 \r
  98 /* Include stddef.h, in order that size_t etc. is defined */\r
  99 #include <stddef.h>\r
 100 \r
 101 \r
 102 /* Type definitions */\r
 103 typedef enum {\r
 104     fmi2OK,\r
 105     fmi2Warning,\r
 106     fmi2Discard,\r
 107     fmi2Error,\r
 108     fmi2Fatal,\r
 109     fmi2Pending\r
 110 } fmi2Status;\r
 111 \r
 112 typedef enum {\r
 113     fmi2ModelExchange,\r
 114     fmi2CoSimulation\r
 115 } fmi2Type;\r
 116 \r
 117 typedef enum {\r
 118     fmi2DoStepStatus,\r
 119     fmi2PendingStatus,\r
 120     fmi2LastSuccessfulTime,\r
 121     fmi2Terminated\r
 122 } fmi2StatusKind;\r
 123 \r
 124 typedef void      (*fmi2CallbackLogger)        (fmi2ComponentEnvironment, fmi2String, fmi2Status, fmi2String, fmi2String, ...);\r
 125 typedef void*     (*fmi2CallbackAllocateMemory)(size_t, size_t);\r
 126 typedef void      (*fmi2CallbackFreeMemory)    (void*);\r
 127 typedef void      (*fmi2StepFinished)          (fmi2ComponentEnvironment, fmi2Status);\r
 128 \r
 129 typedef struct {\r
 130    const fmi2CallbackLogger         logger;\r
 131    const fmi2CallbackAllocateMemory allocateMemory;\r
 132    const fmi2CallbackFreeMemory     freeMemory;\r
 133    const fmi2StepFinished           stepFinished;\r
 134    const fmi2ComponentEnvironment   componentEnvironment;\r
 135 } fmi2CallbackFunctions;\r
 136 \r
 137 typedef struct {\r
 138          fmi2Boolean newDiscreteStatesNeeded;\r
 139    fmi2Boolean terminateSimulation;\r
 140    fmi2Boolean nominalsOfContinuousStatesChanged;\r
 141    fmi2Boolean valuesOfContinuousStatesChanged;\r
 142    fmi2Boolean nextEventTimeDefined;\r
 143    fmi2Real    nextEventTime;\r
 144 } fmi2EventInfo;\r
 145 \r
 146 \r
 147 /* reset alignment policy to the one set before reading this file */\r
 148 #if defined _MSC_VER || defined __GNUC__\r
 149 #pragma pack(pop)\r
 150 #endif\r
 151 \r
 152 \r
 153 /* Define fmi2 function pointer types to simplify dynamic loading */\r
 154 \r
 155 /***************************************************\r
 156 Types for Common Functions\r
 157 ****************************************************/\r
 158 \r
 159 /* Inquire version numbers of header files and setting logging status */\r
 160    typedef const char* fmi2GetTypesPlatformTYPE(void);\r
 161    typedef const char* fmi2GetVersionTYPE(void);\r
 162    typedef fmi2Status  fmi2SetDebugLoggingTYPE(fmi2Component, fmi2Boolean, size_t, const fmi2String[]);\r
 163 \r
 164 /* Creation and destruction of FMU instances and setting debug status */\r
 165    typedef fmi2Component fmi2InstantiateTYPE (fmi2String, fmi2Type, fmi2String, fmi2String, const fmi2CallbackFunctions*, fmi2Boolean, fmi2Boolean);\r
 166    typedef void          fmi2FreeInstanceTYPE(fmi2Component);\r
 167 \r
 168 /* Enter and exit initialization mode, terminate and reset */\r
 169    typedef fmi2Status fmi2SetupExperimentTYPE        (fmi2Component, fmi2Boolean, fmi2Real, fmi2Real, fmi2Boolean, fmi2Real);\r
 170    typedef fmi2Status fmi2EnterInitializationModeTYPE(fmi2Component);\r
 171    typedef fmi2Status fmi2ExitInitializationModeTYPE (fmi2Component);\r
 172    typedef fmi2Status fmi2TerminateTYPE              (fmi2Component);\r
 173    typedef fmi2Status fmi2ResetTYPE                  (fmi2Component);\r
 174 \r
 175 /* Getting and setting variable values */\r
 176    typedef fmi2Status fmi2GetRealTYPE   (fmi2Component, const fmi2ValueReference[], size_t, fmi2Real   []);\r
 177    typedef fmi2Status fmi2GetIntegerTYPE(fmi2Component, const fmi2ValueReference[], size_t, fmi2Integer[]);\r
 178    typedef fmi2Status fmi2GetBooleanTYPE(fmi2Component, const fmi2ValueReference[], size_t, fmi2Boolean[]);\r
 179    typedef fmi2Status fmi2GetStringTYPE (fmi2Component, const fmi2ValueReference[], size_t, fmi2String []);\r
 180 \r
 181    typedef fmi2Status fmi2SetRealTYPE   (fmi2Component, const fmi2ValueReference[], size_t, const fmi2Real   []);\r
 182    typedef fmi2Status fmi2SetIntegerTYPE(fmi2Component, const fmi2ValueReference[], size_t, const fmi2Integer[]);\r
 183    typedef fmi2Status fmi2SetBooleanTYPE(fmi2Component, const fmi2ValueReference[], size_t, const fmi2Boolean[]);\r
 184    typedef fmi2Status fmi2SetStringTYPE (fmi2Component, const fmi2ValueReference[], size_t, const fmi2String []);\r
 185 \r
 186 /* Getting and setting the internal FMU state */\r
 187    typedef fmi2Status fmi2GetFMUstateTYPE           (fmi2Component, fmi2FMUstate*);\r
 188    typedef fmi2Status fmi2SetFMUstateTYPE           (fmi2Component, fmi2FMUstate);\r
 189    typedef fmi2Status fmi2FreeFMUstateTYPE          (fmi2Component, fmi2FMUstate*);\r
 190    typedef fmi2Status fmi2SerializedFMUstateSizeTYPE(fmi2Component, fmi2FMUstate, size_t*);\r
 191    typedef fmi2Status fmi2SerializeFMUstateTYPE     (fmi2Component, fmi2FMUstate, fmi2Byte[], size_t);\r
 192    typedef fmi2Status fmi2DeSerializeFMUstateTYPE   (fmi2Component, const fmi2Byte[], size_t, fmi2FMUstate*);\r
 193 \r
 194 /* Getting partial derivatives */\r
 195    typedef fmi2Status fmi2GetDirectionalDerivativeTYPE(fmi2Component, const fmi2ValueReference[], size_t,\r
 196                                                                    const fmi2ValueReference[], size_t,\r
 197                                                                    const fmi2Real[], fmi2Real[]);\r
 198 \r
 199 /***************************************************\r
 200 Types for Functions for FMI2 for Model Exchange\r
 201 ****************************************************/\r
 202 \r
 203 /* Enter and exit the different modes */\r
 204    typedef fmi2Status fmi2EnterEventModeTYPE         (fmi2Component);\r
 205    typedef fmi2Status fmi2NewDiscreteStatesTYPE      (fmi2Component, fmi2EventInfo*);\r
 206    typedef fmi2Status fmi2EnterContinuousTimeModeTYPE(fmi2Component);\r
 207    typedef fmi2Status fmi2CompletedIntegratorStepTYPE(fmi2Component, fmi2Boolean, fmi2Boolean*, fmi2Boolean*);\r
 208 \r
 209 /* Providing independent variables and re-initialization of caching */\r
 210    typedef fmi2Status fmi2SetTimeTYPE            (fmi2Component, fmi2Real);\r
 211    typedef fmi2Status fmi2SetContinuousStatesTYPE(fmi2Component, const fmi2Real[], size_t);\r
 212 \r
 213 /* Evaluation of the model equations */\r
 214    typedef fmi2Status fmi2GetDerivativesTYPE               (fmi2Component, fmi2Real[], size_t);\r
 215    typedef fmi2Status fmi2GetEventIndicatorsTYPE           (fmi2Component, fmi2Real[], size_t);\r
 216    typedef fmi2Status fmi2GetContinuousStatesTYPE          (fmi2Component, fmi2Real[], size_t);\r
 217    typedef fmi2Status fmi2GetNominalsOfContinuousStatesTYPE(fmi2Component, fmi2Real[], size_t);\r
 218 \r
 219 \r
 220 /***************************************************\r
 221 Types for Functions for FMI2 for Co-Simulation\r
 222 ****************************************************/\r
 223 \r
 224 /* Simulating the slave */\r
 225    typedef fmi2Status fmi2SetRealInputDerivativesTYPE (fmi2Component, const fmi2ValueReference [], size_t, const fmi2Integer [], const fmi2Real []);\r
 226    typedef fmi2Status fmi2GetRealOutputDerivativesTYPE(fmi2Component, const fmi2ValueReference [], size_t, const fmi2Integer [], fmi2Real []);\r
 227 \r
 228    typedef fmi2Status fmi2DoStepTYPE     (fmi2Component, fmi2Real, fmi2Real, fmi2Boolean);\r
 229    typedef fmi2Status fmi2CancelStepTYPE (fmi2Component);\r
 230 \r
 231 /* Inquire slave status */\r
 232    typedef fmi2Status fmi2GetStatusTYPE       (fmi2Component, const fmi2StatusKind, fmi2Status* );\r
 233    typedef fmi2Status fmi2GetRealStatusTYPE   (fmi2Component, const fmi2StatusKind, fmi2Real*   );\r
 234    typedef fmi2Status fmi2GetIntegerStatusTYPE(fmi2Component, const fmi2StatusKind, fmi2Integer*);\r
 235    typedef fmi2Status fmi2GetBooleanStatusTYPE(fmi2Component, const fmi2StatusKind, fmi2Boolean*);\r
 236    typedef fmi2Status fmi2GetStringStatusTYPE (fmi2Component, const fmi2StatusKind, fmi2String* );\r
 237 \r
 238 \r
 239 #ifdef __cplusplus\r
 240 }  /* end of extern "C" { */\r
 241 #endif\r
 242 \r
 243 #endif /* fmi2FunctionTypes_h */\r