org.simantics.fmil.core/native/FMILibrary/src/Import/include/FMI1/fmi1_import_vendor_annotations.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 /** \file fmi1_import_vendor_annotations.h
  17 *  \brief Public interface to the FMI XML C-library. Handling of vendor annotations.
  18 */
  19
  20 #ifndef FMI1_IMPORT_VENDORANNOTATIONS_H_
  21 #define FMI1_IMPORT_VENDORANNOTATIONS_H_
  22
  23 #include <fmilib_config.h>
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 /**\r
  30 * \addtogroup  fmi1_import\r
  31 * @{\r
  32 *       \addtogroup  fmi1_import_annotations Basic support for vendor annotations.\r
  33 *@}\r
  34  * \addtogroup  fmi1_import_annotations Basic support for vendor annotations.\r
  35  @{ \r
  36  */
  37
  38 /** \r
  39 \name Vendor annotation supporting structures\r
  40 */\r
  41 /**@{ */\r
  42         /** \brief  Opaque list of vendor annotations. */\r
  43 typedef struct fmi1_xml_vendor_list_t fmi1_import_vendor_list_t;\r
  44         /** \brief Opaque vendor object. */\r
  45 typedef struct fmi1_xml_vendor_t fmi1_import_vendor_t;\r
  46         /** \brief Opaque annotation object. */\r
  47 typedef struct fmi1_xml_annotation_t fmi1_import_annotation_t;\r
  48 /**@} */\r
  49
  50 /** \brief Get the number of different vendors */
  51 FMILIB_EXPORT unsigned int  fmi1_import_get_number_of_vendors(fmi1_import_vendor_list_t*);
  52
  53 /** \brief Get the annotations associated with vendor specified by the index */
  54 FMILIB_EXPORT fmi1_import_vendor_t* fmi1_import_get_vendor(fmi1_import_vendor_list_t*, unsigned int  index);
  55
  56 /** \brief Get the vendor name */
  57 FMILIB_EXPORT const char* fmi1_import_get_vendor_name(fmi1_import_vendor_t*);
  58
  59 /** \brief Get the number of annotations provided for the vendor */
  60 FMILIB_EXPORT unsigned int  fmi1_import_get_number_of_vendor_annotations(fmi1_import_vendor_t*);
  61
  62 /** \brief Get an annotation object for the vendor by index
  63
  64         Note: Annotations may later be used in other places but have common interface name-value
  65 */
  66 FMILIB_EXPORT fmi1_import_annotation_t* fmi1_import_get_vendor_annotation(fmi1_import_vendor_t*, unsigned int  index);
  67
  68 /** \brief Get the name of the annotation */
  69 FMILIB_EXPORT const char* fmi1_import_get_annotation_name(fmi1_import_annotation_t*);
  70
  71 /** \brief Get the value for the annotation */
  72 FMILIB_EXPORT const char* fmi1_import_get_annotation_value(fmi1_import_annotation_t*);
  73
  74 /** \brief Get the list of all the vendor annotations present in the XML file */
  75 FMILIB_EXPORT fmi1_import_vendor_list_t* fmi1_import_get_vendor_list(fmi1_import_t* fmu);
  76
  77 /** @} */
  78 #ifdef __cplusplus
  79 }
  80 #endif
  81 #endif