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

   1 #ifndef fmi2TypesPlatform_h\r
   2 #define fmi2TypesPlatform_h\r
   3 \r
   4 /* Standard header file to define the argument types of the\r
   5    functions of the Functional Mock-up Interface 2.0.\r
   6    This header file must be utilized both by the model and\r
   7    by the simulation engine.\r
   8 \r
   9    Revisions:\r
  10    - Apr.  9, 2014: all prefixes "fmi" renamed to "fmi2" (decision from April 8)\r
  11    - Mar   31, 2014: New datatype fmiChar introduced.\r
  12    - Feb.  17, 2013: Changed fmiTypesPlatform from "standard32" to "default".\r
  13                      Removed fmiUndefinedValueReference since no longer needed\r
  14                      (because every state is defined in ScalarVariables).\r
  15    - March 20, 2012: Renamed from fmiPlatformTypes.h to fmiTypesPlatform.h\r
  16    - Nov.  14, 2011: Use the header file "fmiPlatformTypes.h" for FMI 2.0\r
  17                      both for "FMI for model exchange" and for "FMI for co-simulation"\r
  18                      New types "fmiComponentEnvironment", "fmiState", and "fmiByte".\r
  19                      The implementation of "fmiBoolean" is change from "char" to "int".\r
  20                      The #define "fmiPlatform" changed to "fmiTypesPlatform"\r
  21                      (in order that #define and function call are consistent)\r
  22    - Oct.   4, 2010: Renamed header file from "fmiModelTypes.h" to fmiPlatformTypes.h"\r
  23                      for the co-simulation interface\r
  24    - Jan.   4, 2010: Renamed meModelTypes_h to fmiModelTypes_h (by Mauss, QTronic)\r
  25    - Dec.  21, 2009: Changed "me" to "fmi" and "meModel" to "fmiComponent"\r
  26                      according to meeting on Dec. 18 (by Martin Otter, DLR)\r
  27    - Dec.   6, 2009: Added meUndefinedValueReference (by Martin Otter, DLR)\r
  28    - Sept.  9, 2009: Changes according to FMI-meeting on July 21:\r
  29                      Changed "version" to "platform", "standard" to "standard32",\r
  30                      Added a precise definition of "standard32" as comment\r
  31                      (by Martin Otter, DLR)\r
  32    - July  19, 2009: Added "me" as prefix to file names, added meTrue/meFalse,\r
  33                      and changed meValueReferenced from int to unsigned int\r
  34                      (by Martin Otter, DLR).\r
  35    - March  2, 2009: Moved enums and function pointer definitions to\r
  36                      ModelFunctions.h (by Martin Otter, DLR).\r
  37    - Dec.  3, 2008 : First version by Martin Otter (DLR) and\r
  38                      Hans Olsson (Dynasim).\r
  39 \r
  40 \r
  41    Copyright © 2008-2011 MODELISAR consortium,\r
  42                2012-2013 Modelica Association Project "FMI"\r
  43                All rights reserved.\r
  44    This file is licensed by the copyright holders under the BSD 2-Clause License\r
  45    (http://www.opensource.org/licenses/bsd-license.html):\r
  46 \r
  47    ----------------------------------------------------------------------------\r
  48    Redistribution and use in source and binary forms, with or without\r
  49    modification, are permitted provided that the following conditions are met:\r
  50 \r
  51    - Redistributions of source code must retain the above copyright notice,\r
  52      this list of conditions and the following disclaimer.\r
  53    - Redistributions in binary form must reproduce the above copyright notice,\r
  54      this list of conditions and the following disclaimer in the documentation\r
  55      and/or other materials provided with the distribution.\r
  56    - Neither the name of the copyright holders nor the names of its\r
  57      contributors may be used to endorse or promote products derived\r
  58      from this software without specific prior written permission.\r
  59 \r
  60    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
  61    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED\r
  62    TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\r
  63    PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR\r
  64    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
  65    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,\r
  66    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;\r
  67    OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,\r
  68    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\r
  69    OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF\r
  70    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  71    ----------------------------------------------------------------------------\r
  72 \r
  73    with the extension:\r
  74 \r
  75    You may distribute or publicly perform any modification only under the\r
  76    terms of this license.\r
  77    (Note, this means that if you distribute a modified file,\r
  78     the modified file must also be provided under this license).\r
  79 */\r
  80 \r
  81 /* Platform (unique identification of this header file) */\r
  82 #define fmi2TypesPlatform "default"\r
  83 \r
  84 /* Type definitions of variables passed as arguments\r
  85    Version "default" means:\r
  86 \r
  87    fmi2Component           : an opaque object pointer\r
  88    fmi2ComponentEnvironment: an opaque object pointer\r
  89    fmi2FMUstate            : an opaque object pointer\r
  90    fmi2ValueReference      : handle to the value of a variable\r
  91    fmi2Real                : double precision floating-point data type\r
  92    fmi2Integer             : basic signed integer data type\r
  93    fmi2Boolean             : basic signed integer data type\r
  94    fmi2Char                : character data type\r
  95    fmi2String              : a pointer to a vector of fmi2Char characters\r
  96                              ('\0' terminated, UTF8 encoded)\r
  97    fmi2Byte                : smallest addressable unit of the machine, typically one byte.\r
  98 */\r
  99    typedef void*           fmi2Component;               /* Pointer to FMU instance       */\r
 100    typedef void*           fmi2ComponentEnvironment;    /* Pointer to FMU environment    */\r
 101    typedef void*           fmi2FMUstate;                /* Pointer to internal FMU state */\r
 102    typedef unsigned int    fmi2ValueReference;\r
 103    typedef double          fmi2Real   ;\r
 104    typedef int             fmi2Integer;\r
 105    typedef int             fmi2Boolean;\r
 106    typedef char            fmi2Char;\r
 107    typedef const fmi2Char* fmi2String;\r
 108    typedef char            fmi2Byte;\r
 109 \r
 110 /* Values for fmi2Boolean  */\r
 111 #define fmi2True  1\r
 112 #define fmi2False 0\r
 113 \r
 114 \r
 115 #endif /* fmi2TypesPlatform_h */\r