org.simantics.fmil.core/native/FMILibrary/src/XML/include/FMI1/fmi1_xml_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_XML_CAPABILITIES_H
  17 #define FMI1_XML_CAPABILITIES_H
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 #include "FMI1/fmi1_xml_model_description.h"
  24         /**
  25                 \file fmi1_xml_capabilities.h
  26                 Functions to retrieve capability flags.
  27         */
  28         /**
  29         \addtogroup fmi1_xml
  30         @{
  31         \addtogroup fmi1_xml_capabilities Functions to retrieve capability flags.
  32         The functions accept a pointer to ::fmi1_xml_capabilities_t returned by fmi1_xml_get_capabilities().
  33         They return the flags as specified by the FMI 1.0 standard. Default values are returned for model-exachange FMUs.
  34         @}
  35         \addtogroup fmi1_xml_capabilities
  36         @{
  37         */
  38 /** \brief Retrieve  canHandleVariableCommunicationStepSize flag. */
  39 int fmi1_xml_get_canHandleVariableCommunicationStepSize(fmi1_xml_capabilities_t* );
  40         /** \brief Retrieve  canHandleEvents flag. */
  41 int fmi1_xml_get_canHandleEvents(fmi1_xml_capabilities_t* );
  42         /** \brief Retrieve  canRejectSteps flag. */
  43 int fmi1_xml_get_canRejectSteps(fmi1_xml_capabilities_t* );
  44         /** \brief Retrieve  canInterpolateInputs flag. */
  45 int fmi1_xml_get_canInterpolateInputs(fmi1_xml_capabilities_t* );
  46         /** \brief Retrieve  maxOutputDerivativeOrder. */
  47 unsigned int fmi1_xml_get_maxOutputDerivativeOrder(fmi1_xml_capabilities_t* );
  48         /** \brief Retrieve  canRunAsynchronuously flag. */
  49 int fmi1_xml_get_canRunAsynchronuously(fmi1_xml_capabilities_t* );
  50         /** \brief Deprecated since 1.0.1, do not use. */
  51 int fmi1_xml_get_canSignalEvents(fmi1_xml_capabilities_t* );
  52         /** \brief Retrieve  canBeInstantiatedOnlyOncePerProcess flag. */
  53 int fmi1_xml_get_canBeInstantiatedOnlyOncePerProcess(fmi1_xml_capabilities_t* );
  54         /** \brief Retrieve  canNotUseMemoryManagementFunctions flag. */
  55 int fmi1_xml_get_canNotUseMemoryManagementFunctions(fmi1_xml_capabilities_t* );
  56
  57 /**
  58 @}
  59 */
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif
  64 #endif /* FMI1_XML_CAPABILITIES_H */