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_import_variable.c
19 * \brief Methods to handle fmi2_import_variable_t.
22 #include <FMI2/fmi2_import_variable.h>
23 #include "fmi2_import_impl.h"
24 #include "fmi2_import_variable_list_impl.h"
26 fmi2_import_variable_t* fmi2_import_get_variable_by_name(fmi2_import_t* fmu, const char* name) {
\r
27 return fmi2_xml_get_variable_by_name(fmu->md, name);
\r
30 fmi2_import_variable_t* fmi2_import_get_variable_by_vr(fmi2_import_t* fmu, fmi2_base_type_enu_t baseType, fmi2_value_reference_t vr) {
\r
31 return fmi2_xml_get_variable_by_vr(fmu->md, baseType, vr);
\r
34 const char* fmi2_import_get_variable_name(fmi2_import_variable_t* v) {
35 return fmi2_xml_get_variable_name(v);
38 const char* fmi2_import_get_variable_description(fmi2_import_variable_t* v) {
39 return fmi2_xml_get_variable_description(v);
42 fmi2_value_reference_t fmi2_import_get_variable_vr(fmi2_import_variable_t* v) {
43 return fmi2_xml_get_variable_vr(v);
47 For scalar variable gives the type definition is present
49 fmi2_import_variable_typedef_t* fmi2_import_get_variable_declared_type(fmi2_import_variable_t* v) {
50 return fmi2_xml_get_variable_declared_type(v);
53 fmi2_base_type_enu_t fmi2_import_get_variable_base_type(fmi2_import_variable_t* v) {
54 return fmi2_xml_get_variable_base_type(v);
57 int fmi2_import_get_variable_has_start(fmi2_import_variable_t* v) {
58 return fmi2_xml_get_variable_has_start(v);
61 fmi2_variability_enu_t fmi2_import_get_variability(fmi2_import_variable_t* v) {
62 return fmi2_xml_get_variability(v);
65 fmi2_causality_enu_t fmi2_import_get_causality(fmi2_import_variable_t* v) {
66 return fmi2_xml_get_causality(v);
69 fmi2_initial_enu_t fmi2_import_get_initial(fmi2_import_variable_t* v) {
70 return fmi2_xml_get_initial(v);
73 fmi2_import_variable_t* fmi2_import_get_previous(fmi2_import_variable_t* v) {
74 return fmi2_xml_get_previous(v);
77 fmi2_boolean_t fmi2_import_get_canHandleMultipleSetPerTimeInstant(fmi2_import_variable_t* v) {
78 return fmi2_xml_get_canHandleMultipleSetPerTimeInstant(v);
82 fmi2_import_real_variable_t* fmi2_import_get_variable_as_real(fmi2_import_variable_t* v) {
83 return fmi2_xml_get_variable_as_real(v);
86 fmi2_import_integer_variable_t* fmi2_import_get_variable_as_integer(fmi2_import_variable_t* v) {
87 return fmi2_xml_get_variable_as_integer(v);
90 fmi2_import_enum_variable_t* fmi2_import_get_variable_as_enum(fmi2_import_variable_t* v) {
91 return fmi2_xml_get_variable_as_enum(v);
94 fmi2_import_string_variable_t* fmi2_import_get_variable_as_string(fmi2_import_variable_t* v) {
95 return fmi2_xml_get_variable_as_string(v);
98 fmi2_import_bool_variable_t* fmi2_import_get_variable_as_boolean(fmi2_import_variable_t* v) {
99 return fmi2_xml_get_variable_as_boolean(v);
102 fmi2_real_t fmi2_import_get_real_variable_start(fmi2_import_real_variable_t* v) {
103 return fmi2_xml_get_real_variable_start(v);
106 fmi2_import_real_variable_t* fmi2_import_get_real_variable_derivative_of(fmi2_import_real_variable_t* v) {
107 return fmi2_xml_get_real_variable_derivative_of(v);
110 fmi2_boolean_t fmi2_import_get_real_variable_reinit(fmi2_import_real_variable_t* v) {
111 return fmi2_xml_get_real_variable_reinit(v);
114 fmi2_real_t fmi2_import_get_real_variable_max(fmi2_import_real_variable_t* v) {
115 return fmi2_xml_get_real_variable_max(v);
118 fmi2_real_t fmi2_import_get_real_variable_min(fmi2_import_real_variable_t* v) {
119 return fmi2_xml_get_real_variable_min(v);
122 fmi2_real_t fmi2_import_get_real_variable_nominal(fmi2_import_real_variable_t* v) {
123 return fmi2_xml_get_real_variable_nominal(v);
126 fmi2_import_unit_t* fmi2_import_get_real_variable_unit(fmi2_import_real_variable_t* v) {
127 return fmi2_xml_get_real_variable_unit(v);
130 fmi2_import_display_unit_t* fmi2_import_get_real_variable_display_unit(fmi2_import_real_variable_t* v){
131 return fmi2_xml_get_real_variable_display_unit(v);
134 const char* fmi2_import_get_string_variable_start(fmi2_import_string_variable_t* v) {
135 return fmi2_xml_get_string_variable_start(v);
138 fmi2_boolean_t fmi2_import_get_boolean_variable_start(fmi2_import_bool_variable_t* v){
139 return fmi2_xml_get_boolean_variable_start(v);
142 int fmi2_import_get_integer_variable_start(fmi2_import_integer_variable_t* v) {
143 return fmi2_xml_get_integer_variable_start(v);
146 int fmi2_import_get_integer_variable_min(fmi2_import_integer_variable_t* v) {
147 return fmi2_xml_get_integer_variable_min(v);
150 int fmi2_import_get_integer_variable_max(fmi2_import_integer_variable_t* v) {
151 return fmi2_xml_get_integer_variable_max(v);
154 int fmi2_import_get_enum_variable_start(fmi2_import_enum_variable_t* v) {
155 return fmi2_xml_get_enum_variable_start(v);
158 int fmi2_import_get_enum_variable_min(fmi2_import_enum_variable_t* v) {
159 return fmi2_xml_get_enum_variable_min(v);
162 int fmi2_import_get_enum_variable_max(fmi2_import_enum_variable_t* v) {
163 return fmi2_xml_get_enum_variable_max(v);
166 fmi2_variable_alias_kind_enu_t fmi2_import_get_variable_alias_kind(fmi2_import_variable_t* v) {
167 return fmi2_xml_get_variable_alias_kind(v);
170 fmi2_import_variable_t* fmi2_import_get_variable_alias_base(fmi2_import_t* fmu,fmi2_import_variable_t* v) {
171 return fmi2_xml_get_variable_alias_base(fmu->md, v);
175 Return the list of all the variables aliased to the given one (including the base one.
176 The list is ordered: base variable, aliases, negated aliases.
178 fmi2_import_variable_list_t* fmi2_import_get_variable_aliases(fmi2_import_t* fmu,fmi2_import_variable_t* v) {
179 fmi2_import_variable_list_t* list = fmi2_import_alloc_variable_list(fmu, 0);
180 if(fmi2_xml_get_variable_aliases(fmu->md, v, &list->variables) != jm_status_success) {
181 fmi2_import_free_variable_list(list);
187 size_t fmi2_import_get_variable_original_order(fmi2_import_variable_t* v) {
188 return fmi2_xml_get_variable_original_order((fmi2_xml_variable_t*)v);