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 fmi1_import_variable.c
19 * \brief Methods to handle fmi1_import_variable_t.
22 #include <FMI1/fmi1_import_variable.h>
23 #include "fmi1_import_impl.h"
24 #include "fmi1_import_variable_list_impl.h"
26 fmi1_import_variable_t* fmi1_import_get_variable_by_name(fmi1_import_t* fmu, const char* name) {
\r
27 return fmi1_xml_get_variable_by_name(fmu->md, name);
\r
30 fmi1_import_variable_t* fmi1_import_get_variable_by_vr(fmi1_import_t* fmu, fmi1_base_type_enu_t baseType, fmi1_value_reference_t vr) {
\r
31 return fmi1_xml_get_variable_by_vr(fmu->md, baseType, vr);
\r
34 const char* fmi1_import_get_variable_name(fmi1_import_variable_t* v) {
35 return fmi1_xml_get_variable_name(v);
38 const char* fmi1_import_get_variable_description(fmi1_import_variable_t* v) {
39 return fmi1_xml_get_variable_description(v);
42 fmi1_value_reference_t fmi1_import_get_variable_vr(fmi1_import_variable_t* v) {
43 return fmi1_xml_get_variable_vr(v);
47 For scalar variable gives the type definition is present
49 fmi1_import_variable_typedef_t* fmi1_import_get_variable_declared_type(fmi1_import_variable_t* v) {
50 return fmi1_xml_get_variable_declared_type(v);
53 fmi1_base_type_enu_t fmi1_import_get_variable_base_type(fmi1_import_variable_t* v) {
54 return fmi1_xml_get_variable_base_type(v);
57 int fmi1_import_get_variable_has_start(fmi1_import_variable_t* v) {
58 return fmi1_xml_get_variable_has_start(v);
61 int fmi1_import_get_variable_is_fixed(fmi1_import_variable_t* v) {
62 return fmi1_xml_get_variable_is_fixed(v);
65 fmi1_variability_enu_t fmi1_import_get_variability(fmi1_import_variable_t* v) {
66 return fmi1_xml_get_variability(v);
69 fmi1_causality_enu_t fmi1_import_get_causality(fmi1_import_variable_t* v) {
70 return fmi1_xml_get_causality(v);
73 /* DirectDependency is returned for variables with causality Output. Null pointer for others. */
74 fmi1_import_variable_list_t* fmi1_import_get_direct_dependency(fmi1_import_t* fmu, fmi1_import_variable_t* v) {
75 fmi1_import_variable_list_t* list = fmi1_import_alloc_variable_list(fmu, fmi1_xml_get_direct_dependency_size(fmu->md,v));
76 if(fmi1_xml_get_direct_dependency(fmu->md,v,&list->variables) != jm_status_success) {
77 fmi1_import_free_variable_list(list);
83 fmi1_import_real_variable_t* fmi1_import_get_variable_as_real(fmi1_import_variable_t* v) {
84 return fmi1_xml_get_variable_as_real(v);
87 fmi1_import_integer_variable_t* fmi1_import_get_variable_as_integer(fmi1_import_variable_t* v) {
88 return fmi1_xml_get_variable_as_integer(v);
91 fmi1_import_enum_variable_t* fmi1_import_get_variable_as_enum(fmi1_import_variable_t* v) {
92 return fmi1_xml_get_variable_as_enum(v);
95 fmi1_import_string_variable_t* fmi1_import_get_variable_as_string(fmi1_import_variable_t* v) {
96 return fmi1_xml_get_variable_as_string(v);
99 fmi1_import_bool_variable_t* fmi1_import_get_variable_as_boolean(fmi1_import_variable_t* v) {
100 return fmi1_xml_get_variable_as_boolean(v);
103 fmi1_real_t fmi1_import_get_real_variable_start(fmi1_import_real_variable_t* v) {
104 return fmi1_xml_get_real_variable_start(v);
107 fmi1_real_t fmi1_import_get_real_variable_max(fmi1_import_real_variable_t* v) {
108 return fmi1_xml_get_real_variable_max(v);
111 fmi1_real_t fmi1_import_get_real_variable_min(fmi1_import_real_variable_t* v) {
112 return fmi1_xml_get_real_variable_min(v);
115 fmi1_real_t fmi1_import_get_real_variable_nominal(fmi1_import_real_variable_t* v) {
116 return fmi1_xml_get_real_variable_nominal(v);
119 fmi1_import_unit_t* fmi1_import_get_real_variable_unit(fmi1_import_real_variable_t* v) {
120 return fmi1_xml_get_real_variable_unit(v);
123 fmi1_import_display_unit_t* fmi1_import_get_real_variable_display_unit(fmi1_import_real_variable_t* v){
124 return fmi1_xml_get_real_variable_display_unit(v);
127 const char* fmi1_import_get_string_variable_start(fmi1_import_string_variable_t* v) {
128 return fmi1_xml_get_string_variable_start(v);
131 fmi1_boolean_t fmi1_import_get_boolean_variable_start(fmi1_import_bool_variable_t* v){
132 return fmi1_xml_get_boolean_variable_start(v);
135 int fmi1_import_get_integer_variable_start(fmi1_import_integer_variable_t* v) {
136 return fmi1_xml_get_integer_variable_start(v);
139 int fmi1_import_get_integer_variable_min(fmi1_import_integer_variable_t* v) {
140 return fmi1_xml_get_integer_variable_min(v);
143 int fmi1_import_get_integer_variable_max(fmi1_import_integer_variable_t* v) {
144 return fmi1_xml_get_integer_variable_max(v);
147 int fmi1_import_get_enum_variable_start(fmi1_import_enum_variable_t* v) {
148 return fmi1_xml_get_enum_variable_start(v);
151 int fmi1_import_get_enum_variable_min(fmi1_import_enum_variable_t* v) {
152 return fmi1_xml_get_enum_variable_min(v);
155 int fmi1_import_get_enum_variable_max(fmi1_import_enum_variable_t* v) {
156 return fmi1_xml_get_enum_variable_max(v);
159 fmi1_variable_alias_kind_enu_t fmi1_import_get_variable_alias_kind(fmi1_import_variable_t* v) {
160 return fmi1_xml_get_variable_alias_kind(v);
163 fmi1_import_variable_t* fmi1_import_get_variable_alias_base(fmi1_import_t* fmu,fmi1_import_variable_t* v) {
164 return fmi1_xml_get_variable_alias_base(fmu->md, v);
168 Return the list of all the variables aliased to the given one (including the base one.
169 The list is ordered: base variable, aliases, negated aliases.
171 fmi1_import_variable_list_t* fmi1_import_get_variable_aliases(fmi1_import_t* fmu,fmi1_import_variable_t* v) {
172 fmi1_import_variable_list_t* list = fmi1_import_alloc_variable_list(fmu, 0);
173 if(fmi1_xml_get_variable_aliases(fmu->md, v, &list->variables) != jm_status_success) {
174 fmi1_import_free_variable_list(list);
180 size_t fmi1_import_get_variable_original_order(fmi1_import_variable_t* v) {
181 return fmi1_xml_get_variable_original_order((fmi1_xml_variable_t*)v);