org.simantics.fmil.core/native/FMILibrary/src/XML/include/FMI1/fmi1_xml_variable.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
  17
  18 /** \file fmi1_xml_variable.h
  19 *  \brief Public interface to the FMI XML C-library. Handling of model variables.
  20 */
  21
  22 #ifndef FMI1_XML_VARIABLE_H_
  23 #define FMI1_XML_VARIABLE_H_
  24
  25 #include "fmi1_xml_model_description.h"
  26 #include "fmi1_xml_type.h"
  27
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32                 /**
  33         \addtogroup fmi1_xml
  34         @{
  35         \addtogroup fmi1_xml_variables Functions for handling variable definitions.
  36         @}
  37         \addtogroup fmi1_xml_variables Functions for handling variable definitions.
  38         @{
  39         */
  40 const char* fmi1_xml_get_variable_name(fmi1_xml_variable_t*);
  41 const char* fmi1_xml_get_variable_description(fmi1_xml_variable_t*);
  42
  43 size_t fmi1_xml_get_variable_original_order(fmi1_xml_variable_t* v);
  44
  45 fmi1_value_reference_t fmi1_xml_get_variable_vr(fmi1_xml_variable_t*);
  46
  47 /*
  48     For scalar variable gives the type definition is present
  49 */
  50 fmi1_xml_variable_typedef_t* fmi1_xml_get_variable_declared_type(fmi1_xml_variable_t*);
  51 fmi1_base_type_enu_t fmi1_xml_get_variable_base_type(fmi1_xml_variable_t*);
  52
  53 int   fmi1_xml_get_variable_has_start(fmi1_xml_variable_t*);
  54 int   fmi1_xml_get_variable_is_fixed(fmi1_xml_variable_t*);
  55
  56 fmi1_variability_enu_t fmi1_xml_get_variability(fmi1_xml_variable_t*);
  57
  58 fmi1_causality_enu_t fmi1_xml_get_causality(fmi1_xml_variable_t*);
  59
  60 /* DirectDependency is returned for variables with causality Output. Null pointer for others. */
  61 size_t fmi1_xml_get_direct_dependency_size(fmi1_xml_model_description_t* md,fmi1_xml_variable_t*);
  62 jm_status_enu_t fmi1_xml_get_direct_dependency(fmi1_xml_model_description_t* md,fmi1_xml_variable_t*, jm_vector(jm_voidp)*);
  63
  64 fmi1_xml_real_variable_t* fmi1_xml_get_variable_as_real(fmi1_xml_variable_t*);
  65 fmi1_xml_integer_variable_t* fmi1_xml_get_variable_as_integer(fmi1_xml_variable_t*);
  66 fmi1_xml_enum_variable_t* fmi1_xml_get_variable_as_enum(fmi1_xml_variable_t*);
  67 fmi1_xml_string_variable_t* fmi1_xml_get_variable_as_string(fmi1_xml_variable_t*);
  68 fmi1_xml_bool_variable_t* fmi1_xml_get_variable_as_boolean(fmi1_xml_variable_t*);
  69
  70 double fmi1_xml_get_real_variable_start(fmi1_xml_real_variable_t* v);
  71 double fmi1_xml_get_real_variable_max(fmi1_xml_real_variable_t* v);
  72 double fmi1_xml_get_real_variable_min(fmi1_xml_real_variable_t* v);
  73 double fmi1_xml_get_real_variable_nominal(fmi1_xml_real_variable_t* v);
  74 fmi1_xml_unit_t* fmi1_xml_get_real_variable_unit(fmi1_xml_real_variable_t* v);
  75 fmi1_xml_display_unit_t* fmi1_xml_get_real_variable_display_unit(fmi1_xml_real_variable_t* v);
  76
  77 const char* fmi1_xml_get_string_variable_start(fmi1_xml_string_variable_t* v);
  78 fmi1_boolean_t fmi1_xml_get_boolean_variable_start(fmi1_xml_bool_variable_t* v);
  79
  80 int fmi1_xml_get_integer_variable_start(fmi1_xml_integer_variable_t* v);
  81 int fmi1_xml_get_integer_variable_min(fmi1_xml_integer_variable_t* v);
  82 int fmi1_xml_get_integer_variable_max(fmi1_xml_integer_variable_t* v);
  83
  84 int fmi1_xml_get_enum_variable_start(fmi1_xml_enum_variable_t* v);
  85 int fmi1_xml_get_enum_variable_min(fmi1_xml_enum_variable_t* v);
  86 int fmi1_xml_get_enum_variable_max(fmi1_xml_enum_variable_t* v);
  87
  88
  89 fmi1_variable_alias_kind_enu_t fmi1_xml_get_variable_alias_kind(fmi1_xml_variable_t*);
  90 fmi1_xml_variable_t* fmi1_xml_get_variable_alias_base(fmi1_xml_model_description_t* md,fmi1_xml_variable_t*);
  91
  92 /**
  93     Return the list of all the variables aliased to the given one (including the base one.
  94     The list is ordered: base variable, aliases, negated aliases.
  95 */
  96 jm_status_enu_t fmi1_xml_get_variable_aliases(fmi1_xml_model_description_t* md, fmi1_xml_variable_t*, jm_vector(jm_voidp)*);
  97 /* fmi1_xml_variable_list_t* fmi1_xml_get_variable_aliases(fmi1_xml_model_description_t* md,fmi1_xml_variable_t*); */
  98
  99 /**
 100 @}
 101 */
 102 #ifdef __cplusplus
 103 }
 104 #endif
 105 #endif