org.simantics.fmil.core/native/FMILibrary/src/Import/include/FMI1/fmi1_import_cosim.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_COSIM_H
  17 #define FMI1_IMPORT_COSIM_H
  18
  19 #include <FMI/fmi_import_context.h>
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif
  24
  25         /**
  26                 \file fmi1_import_cosim.h
  27                 Functions to retrieve co-simulation related information.
  28         */
  29         /**
  30         \addtogroup fmi1_import
  31         @{
  32         \addtogroup fmi1_import_cosim Functions to retrieve co-simulation related information.
  33         @}
  34         */
  35         /**
  36         \addtogroup fmi1_import_cosim
  37         @{
  38         */
  39
  40         /** \brief Get the entry point.*/
  41 FMILIB_EXPORT const char* fmi1_import_get_entry_point(fmi1_import_t* );
  42         /** \brief Get mime type. */
  43 FMILIB_EXPORT const char* fmi1_import_get_mime_type(fmi1_import_t* );
  44         /** \brief Get manual start flag. */
  45 FMILIB_EXPORT int fmi1_import_get_manual_start(fmi1_import_t* );
  46
  47         /** \brief Get the number of additional models specified. */
  48 FMILIB_EXPORT size_t fmi1_import_get_number_of_additional_models(fmi1_import_t* fmu);
  49
  50         /** \brief Get the name of an additional model.
  51                 @param fmu - the FMU processed
  52                 @param index - the index of an additional model (must be less than the number returned by fmi1_import_get_number_of_additional_models().
  53         */
  54 FMILIB_EXPORT const char* fmi1_import_get_additional_model_name(fmi1_import_t* fmu, size_t index);
  55
  56 /**
  57 @}
  58 */
  59 #ifdef __cplusplus
  60 }
  61 #endif
  62 #endif /* FMI1_IMPORT_COSIM_H */