org.simantics.fmil.core/native/FMILibrary/src/Import/include/FMI1/fmi1_import_capabilities.h

   1 /*
   2     Copyright (C) 2012 Modelon AB
   3
   4     This program is free software: you can redistribute it and/or modify
   5     it under the terms of the BSD style license.
   6
   7      This program is distributed in the hope that it will be useful,
   8     but WITHOUT ANY WARRANTY; without even the implied warranty of
   9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10     FMILIB_License.txt file for more details.
  11
  12     You should have received a copy of the FMILIB_License.txt file
  13     along with this program. If not, contact Modelon AB <http://www.modelon.com>.
  14 */
  15
  16 #ifndef FMI1_IMPORT_CAPABILITIES_H
  17 #define FMI1_IMPORT_CAPABILITIES_H
  18 \r
  19 #include <fmilib_config.h>\r
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25         /**
  26                 \file fmi1_import_capabilities.h
  27                 Functions to retrieve capability flags.
  28         */
  29         /**
  30         \addtogroup fmi1_import
  31         @{
  32         \addtogroup fmi1_import_capabilities Functions to retrieve capability flags.
  33         The functions accept a pointer to ::fmi1_import_capabilities_t returned by fmi1_import_get_capabilities().
  34         They return the flags as specified by the FMI 1.0 standard. Default values are returned for model-exachange FMUs.
  35         @}
  36         \addtogroup fmi1_import_capabilities
  37         @{
  38         */
  39 /**\name FMU capabilities flags */\r
  40 /**@{ */\r
  41 /** \brief A container for all the capability flags */\r
  42 typedef struct fmi1_xml_capabilities_t fmi1_import_capabilities_t;\r
  43 /** @} */\r
  44
  45         /** \brief Retrieve  canHandleVariableCommunicationStepSize flag. */
  46 FMILIB_EXPORT int fmi1_import_get_canHandleVariableCommunicationStepSize(fmi1_import_capabilities_t* );
  47         /** \brief Retrieve  canHandleEvents flag. */
  48 FMILIB_EXPORT int fmi1_import_get_canHandleEvents(fmi1_import_capabilities_t* );
  49         /** \brief Retrieve  canRejectSteps flag. */
  50 FMILIB_EXPORT int fmi1_import_get_canRejectSteps(fmi1_import_capabilities_t* );
  51         /** \brief Retrieve  canInterpolateInputs flag. */
  52 FMILIB_EXPORT int fmi1_import_get_canInterpolateInputs(fmi1_import_capabilities_t* );
  53         /** \brief Retrieve  maxOutputDerivativeOrder. */
  54 FMILIB_EXPORT unsigned int fmi1_import_get_maxOutputDerivativeOrder(fmi1_import_capabilities_t* );
  55         /** \brief Retrieve  canRunAsynchronuously flag. */
  56 FMILIB_EXPORT int fmi1_import_get_canRunAsynchronuously(fmi1_import_capabilities_t* );
  57         /** \brief Deprecated since 1.0.1, do not use. */
  58 FMILIB_EXPORT int fmi1_import_get_canSignalEvents(fmi1_import_capabilities_t* );
  59         /** \brief Retrieve  canBeInstantiatedOnlyOncePerProcess flag. */
  60 FMILIB_EXPORT int fmi1_import_get_canBeInstantiatedOnlyOncePerProcess(fmi1_import_capabilities_t* );
  61         /** \brief Retrieve  canNotUseMemoryManagementFunctions flag. */
  62 FMILIB_EXPORT int fmi1_import_get_canNotUseMemoryManagementFunctions(fmi1_import_capabilities_t* );
  63 /**
  64 @}
  65 */
  66
  67 #ifdef __cplusplus
  68 }
  69 #endif
  70 #endif /* FMI1_IMPORT_CAPABILITIES_H */