FMI Library: part of JModelica.org
fmi1_import_variable.h
Go to the documentation of this file.
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 
22 #ifndef FMI1_IMPORT_VARIABLE_H_
23 #define FMI1_IMPORT_VARIABLE_H_
24 
25 #include <FMI/fmi_import_context.h>
26 
27 #include "fmi1_import_type.h"
28 #include "fmi1_import_unit.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
51 typedef struct fmi1_xml_variable_t fmi1_import_variable_t;
53 typedef struct fmi1_xml_real_variable_t fmi1_import_real_variable_t;
55 typedef struct fmi1_xml_integer_variable_t fmi1_import_integer_variable_t;
57 typedef struct fmi1_xml_string_variable_t fmi1_import_string_variable_t;
59 typedef struct fmi1_xml_enum_variable_t fmi1_import_enum_variable_t;
61 typedef struct fmi1_xml_bool_variable_t fmi1_import_bool_variable_t;
73 
82 
83 
86 
91 
94 
99 
102 
107 
110 
113 
119 
140 
147 
153 
159 
162 
165 
168 
171 
174 
181 
188 
191 
194 
197 #ifdef __cplusplus
198 }
199 #endif
200 #endif
FMILIB_EXPORT fmi1_import_integer_variable_t * fmi1_import_get_variable_as_integer(fmi1_import_variable_t *)
Cast general variable to a one with the specific type.
FMILIB_EXPORT fmi1_causality_enu_t fmi1_import_get_causality(fmi1_import_variable_t *)
Get causality attribute.
FMILIB_EXPORT int fmi1_import_get_enum_variable_min(fmi1_import_enum_variable_t *v)
Get minimal value for the variable.
struct fmi1_xml_unit_t fmi1_import_unit_t
A variable unit defined with a unit defition.
FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_nominal(fmi1_import_real_variable_t *v)
Get nominal value for the variable.
fmi1_variable_alias_kind_enu_t
Alias property for variables.
Definition: fmi1_enums.h:85
FMILIB_EXPORT const char * fmi1_import_get_variable_name(fmi1_import_variable_t *)
Get the variable name.
FMILIB_EXPORT fmi1_import_real_variable_t * fmi1_import_get_variable_as_real(fmi1_import_variable_t *)
Cast general variable to a one with the specific type.
FMILIB_EXPORT int fmi1_import_get_enum_variable_start(fmi1_import_enum_variable_t *v)
Get start value for the variable.
Import context is the entry point to the library. It is used to initialize, unzip, get FMI version and start parsing.
FMILIB_EXPORT fmi1_import_bool_variable_t * fmi1_import_get_variable_as_boolean(fmi1_import_variable_t *)
Cast general variable to a one with the specific type.
fmi1_variability_enu_t
Variability property for variables.
Definition: fmi1_enums.h:61
struct fmi1_import_variable_list_t fmi1_import_variable_list_t
List of variables.
FMILIB_EXPORT int fmi1_import_get_enum_variable_max(fmi1_import_enum_variable_t *v)
Get max value for the variable.
FMILIB_EXPORT int fmi1_import_get_integer_variable_min(fmi1_import_integer_variable_t *v)
Get minimal value for the variable.
FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_min(fmi1_import_real_variable_t *v)
Get minimal value for the variable.
FMILIB_EXPORT fmi1_import_enum_variable_t * fmi1_import_get_variable_as_enum(fmi1_import_variable_t *)
Cast general variable to a one with the specific type.
struct fmi1_xml_integer_variable_t fmi1_import_integer_variable_t
Opaque integer variable.
FMILIB_EXPORT int fmi1_import_get_integer_variable_start(fmi1_import_integer_variable_t *v)
Get start value for the variable.
return v
struct fmi1_xml_variable_t fmi1_import_variable_t
General variable type.
FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_start(fmi1_import_real_variable_t *v)
Get the variable start attribute.
FMILIB_EXPORT fmi1_variable_alias_kind_enu_t fmi1_import_get_variable_alias_kind(fmi1_import_variable_t *)
Get the variable alias kind.
FMILIB_EXPORT int fmi1_import_get_variable_has_start(fmi1_import_variable_t *)
Check if the variable has "start" attribute.
FMILIB_EXPORT fmi1_import_unit_t * fmi1_import_get_real_variable_unit(fmi1_import_real_variable_t *v)
Get associated "unit" object if any.
#define FMILIB_EXPORT
Used to declare the public API of the library needed for dynamic linking.
fmi1_capi_t * fmu
struct fmi1_xml_bool_variable_t fmi1_import_bool_variable_t
Opaque boolean variable.
struct fmi1_xml_string_variable_t fmi1_import_string_variable_t
Opaque string variable.
Public interface to the FMI import C-library. Handling of variable units.
FMILIB_EXPORT int fmi1_import_get_variable_is_fixed(fmi1_import_variable_t *)
Get the variable "fixed" attribute.
FMILIB_EXPORT 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)
Get variable by value reference.
struct fmi1_xml_variable_typedef_t fmi1_import_variable_typedef_t
Opaque general variable type definition object.
size_t fmi1_import_get_variable_original_order(fmi1_import_variable_t *v)
Get the original index in xml of the variable.
FMILIB_EXPORT fmi1_import_display_unit_t * fmi1_import_get_real_variable_display_unit(fmi1_import_real_variable_t *v)
Get associated "display unit" object if any.
FMILIB_EXPORT fmi1_base_type_enu_t fmi1_import_get_variable_base_type(fmi1_import_variable_t *)
Get variable base type.
fmi1_base_type_enu_t
Base types used in type definitions.
Definition: fmi1_enums.h:92
FMILIB_EXPORT fmi1_boolean_t fmi1_import_get_boolean_variable_start(fmi1_import_bool_variable_t *v)
Get start value for the variable.
struct fmi1_import_t fmi1_import_t
FMU version 1.0 object.
struct fmi1_xml_display_unit_t fmi1_import_display_unit_t
A display unit.
FMILIB_EXPORT fmi1_value_reference_t fmi1_import_get_variable_vr(fmi1_import_variable_t *)
Get variable value reference.
fmi1_causality_enu_t
Causality property for variables.
Definition: fmi1_enums.h:73
FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_max(fmi1_import_real_variable_t *v)
Get maximum value for the variable.
FMILIB_EXPORT fmi1_import_string_variable_t * fmi1_import_get_variable_as_string(fmi1_import_variable_t *)
Cast general variable to a one with the specific type.
struct fmi1_xml_real_variable_t fmi1_import_real_variable_t
Opaque real variable.
FMILIB_EXPORT fmi1_import_variable_t * fmi1_import_get_variable_by_name(fmi1_import_t *fmu, const char *name)
Get variable by variable name.
FMILIB_EXPORT const char * fmi1_import_get_variable_description(fmi1_import_variable_t *)
Get variable description.
struct fmi1_xml_enum_variable_t fmi1_import_enum_variable_t
Opaque enumeration variable.
FMILIB_EXPORT fmi1_variability_enu_t fmi1_import_get_variability(fmi1_import_variable_t *)
Get variability attribute.
Public interface to the FMI XML C-library: variable types handling.
FMILIB_EXPORT fmi1_import_variable_typedef_t * fmi1_import_get_variable_declared_type(fmi1_import_variable_t *)
For scalar variable gives the type definition is present.
FMILIB_EXPORT int fmi1_import_get_integer_variable_max(fmi1_import_integer_variable_t *v)
Get max value for the variable.
FMILIB_EXPORT const char * fmi1_import_get_string_variable_start(fmi1_import_string_variable_t *v)
Get start value for the variable.