2 Copyright (C) 2012 Modelon AB
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the BSD style license.
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.
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>.
18 /** \file fmi2_xml_variable.h
19 * \brief Public interface to the FMI XML C-library. Handling of model variables.
22 #ifndef FMI2_XML_VARIABLE_H_
23 #define FMI2_XML_VARIABLE_H_
25 #include "fmi2_xml_model_description.h"
26 #include "fmi2_xml_type.h"
35 \addtogroup fmi2_xml_variables Functions for handling variable definitions.
37 \addtogroup fmi2_xml_variables Functions for handling variable definitions.
40 const char* fmi2_xml_get_variable_name(fmi2_xml_variable_t*);
41 const char* fmi2_xml_get_variable_description(fmi2_xml_variable_t*);
43 size_t fmi2_xml_get_variable_original_order(fmi2_xml_variable_t* v);
45 fmi2_value_reference_t fmi2_xml_get_variable_vr(fmi2_xml_variable_t*);
48 For scalar variable gives the type definition is present
50 fmi2_xml_variable_typedef_t* fmi2_xml_get_variable_declared_type(fmi2_xml_variable_t*);
51 fmi2_base_type_enu_t fmi2_xml_get_variable_base_type(fmi2_xml_variable_t*);
53 int fmi2_xml_get_variable_has_start(fmi2_xml_variable_t*);
55 fmi2_variability_enu_t fmi2_xml_get_variability(fmi2_xml_variable_t*);
56 fmi2_causality_enu_t fmi2_xml_get_causality(fmi2_xml_variable_t*);
57 fmi2_initial_enu_t fmi2_xml_get_initial(fmi2_xml_variable_t*);
59 fmi2_xml_variable_t* fmi2_xml_get_previous(fmi2_xml_variable_t* v);
60 fmi2_boolean_t fmi2_xml_get_canHandleMultipleSetPerTimeInstant(fmi2_xml_variable_t* v);
62 fmi2_xml_real_variable_t* fmi2_xml_get_variable_as_real(fmi2_xml_variable_t*);
63 fmi2_xml_integer_variable_t* fmi2_xml_get_variable_as_integer(fmi2_xml_variable_t*);
64 fmi2_xml_enum_variable_t* fmi2_xml_get_variable_as_enum(fmi2_xml_variable_t*);
65 fmi2_xml_string_variable_t* fmi2_xml_get_variable_as_string(fmi2_xml_variable_t*);
66 fmi2_xml_bool_variable_t* fmi2_xml_get_variable_as_boolean(fmi2_xml_variable_t*);
68 double fmi2_xml_get_real_variable_start(fmi2_xml_real_variable_t* v);
69 fmi2_xml_real_variable_t* fmi2_xml_get_real_variable_derivative_of(fmi2_xml_real_variable_t* v);
70 fmi2_boolean_t fmi2_xml_get_real_variable_reinit(fmi2_xml_real_variable_t* v);
71 double fmi2_xml_get_real_variable_max(fmi2_xml_real_variable_t* v);
72 double fmi2_xml_get_real_variable_min(fmi2_xml_real_variable_t* v);
73 double fmi2_xml_get_real_variable_nominal(fmi2_xml_real_variable_t* v);
74 fmi2_xml_unit_t* fmi2_xml_get_real_variable_unit(fmi2_xml_real_variable_t* v);
75 fmi2_xml_display_unit_t* fmi2_xml_get_real_variable_display_unit(fmi2_xml_real_variable_t* v);
77 const char* fmi2_xml_get_string_variable_start(fmi2_xml_string_variable_t* v);
78 fmi2_boolean_t fmi2_xml_get_boolean_variable_start(fmi2_xml_bool_variable_t* v);
80 int fmi2_xml_get_integer_variable_start(fmi2_xml_integer_variable_t* v);
81 int fmi2_xml_get_integer_variable_min(fmi2_xml_integer_variable_t* v);
82 int fmi2_xml_get_integer_variable_max(fmi2_xml_integer_variable_t* v);
84 int fmi2_xml_get_enum_variable_start(fmi2_xml_enum_variable_t* v);
85 int fmi2_xml_get_enum_variable_min(fmi2_xml_enum_variable_t* v);
86 int fmi2_xml_get_enum_variable_max(fmi2_xml_enum_variable_t* v);
89 fmi2_variable_alias_kind_enu_t fmi2_xml_get_variable_alias_kind(fmi2_xml_variable_t*);
90 fmi2_xml_variable_t* fmi2_xml_get_variable_alias_base(fmi2_xml_model_description_t* md,fmi2_xml_variable_t*);
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.
96 jm_status_enu_t fmi2_xml_get_variable_aliases(fmi2_xml_model_description_t* md, fmi2_xml_variable_t*, jm_vector(jm_voidp)*);
97 /* fmi2_xml_variable_list_t* fmi2_xml_get_variable_aliases(fmi2_xml_model_description_t* md,fmi2_xml_variable_t*); */