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>.
16 /** \file fmi2_import_unit.h
17 * \brief Public interface to the FMI import C-library. Handling of variable units.
20 #ifndef FMI2_IMPORT_UNIT_H_
21 #define FMI2_IMPORT_UNIT_H_
23 #include <fmilib_config.h>
\r
30 \addtogroup fmi2_import
32 \addtogroup fmi2_import_units Functions for handling unit definitions.
34 \addtogroup fmi2_import_units Functions for handling unit definitions.
38 /**\name Structures encapsulating unit information */
\r
40 /** \brief A variable unit defined with a unit defition */
\r
41 typedef struct fmi2_xml_unit_t fmi2_import_unit_t;
\r
42 /** \brief A display unit. */
\r
43 typedef struct fmi2_xml_display_unit_t fmi2_import_display_unit_t;
\r
44 /** \brief The list of all the unit definitions in the model */
\r
45 typedef struct fmi2_xml_unit_definitions_t fmi2_import_unit_definitions_t;
\r
48 /** \brief Get the number of unit definitions. */
49 FMILIB_EXPORT unsigned int fmi2_import_get_unit_definitions_number(fmi2_import_unit_definitions_t*);
51 /** \brief Get a unit definition */
52 FMILIB_EXPORT fmi2_import_unit_t* fmi2_import_get_unit(fmi2_import_unit_definitions_t*, unsigned int index);
54 /** \brief Get a unit name */
55 FMILIB_EXPORT const char* fmi2_import_get_unit_name(fmi2_import_unit_t*);
57 /** \brief Get the number of display units associated with this unit */
58 FMILIB_EXPORT unsigned int fmi2_import_get_unit_display_unit_number(fmi2_import_unit_t*);
61 \brief Get fmi2_SI_base_units_Num SI base units exponents associated with the unit.
63 FMILIB_EXPORT const int* fmi2_import_get_SI_unit_exponents(fmi2_import_unit_t*);
66 \brief Get factor to the corresponding SI base units.
68 FMILIB_EXPORT double fmi2_import_get_SI_unit_factor(fmi2_import_unit_t*);
71 \brief Get offset to the corresponding SI base units.
73 FMILIB_EXPORT double fmi2_import_get_SI_unit_offset(fmi2_import_unit_t*);
76 \brief Convert a value with respect to the unit to the
77 value with respect to the SI base unit.
79 FMILIB_EXPORT double fmi2_import_convert_to_SI_base_unit(double, fmi2_import_unit_t*);
82 \brief Convert a value with respect to the SI base unit to the
83 value with respect to the unit.
85 FMILIB_EXPORT double fmi2_import_convert_from_SI_base_unit(double, fmi2_import_unit_t*);
87 /** \brief Get a display unit object by index.
88 @param index The index of display unit to be returned. Must be less than the number returned by fmi2_import_get_unit_display_unit_number()
90 FMILIB_EXPORT fmi2_import_display_unit_t* fmi2_import_get_unit_display_unit(fmi2_import_unit_t*, size_t index);
93 \brief Get unit defition for a display unit.
95 FMILIB_EXPORT fmi2_import_unit_t* fmi2_import_get_base_unit(fmi2_import_display_unit_t*);
97 \brief Get display unit name
99 FMILIB_EXPORT const char* fmi2_import_get_display_unit_name(fmi2_import_display_unit_t*);
102 \brief Get the "factor" associated with the display unit.
104 FMILIB_EXPORT fmi2_real_t fmi2_import_get_display_unit_factor(fmi2_import_display_unit_t*);
106 \brief Get the "offset" associated with the display unit.
108 FMILIB_EXPORT fmi2_real_t fmi2_import_get_display_unit_offset(fmi2_import_display_unit_t*);
111 \brief Convert a value measured in "units" to a value measured with "display units"
112 @param value The value to be converted.
113 @param du The display unit object
114 @param isRelativeQuantity specifies if "offset" should be incorporated into conversion
116 FMILIB_EXPORT fmi2_real_t fmi2_import_convert_to_display_unit(fmi2_real_t value , fmi2_import_display_unit_t* du, int isRelativeQuantity);
120 \brief Convert a value measured in "display units" to a value measured with "units"
121 @param value The value to be converted.
122 @param du The display unit object
123 @param isRelativeQuantity specifies if "offset" should be incorporated into conversion
125 FMILIB_EXPORT fmi2_real_t fmi2_import_convert_from_display_unit(fmi2_real_t value, fmi2_import_display_unit_t* du, int isRelativeQuantity);