FMI Library: part of JModelica.org
fmi2_import_unit.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 
20 #ifndef FMI2_IMPORT_UNIT_H_
21 #define FMI2_IMPORT_UNIT_H_
22 
23 #include <fmilib_config.h>
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
41 typedef struct fmi2_xml_unit_t fmi2_import_unit_t;
43 typedef struct fmi2_xml_display_unit_t fmi2_import_display_unit_t;
45 typedef struct fmi2_xml_unit_definitions_t fmi2_import_unit_definitions_t;
50 
53 
56 
59 
64 
69 
74 
80 
86 
91 
100 
109 
116 FMILIB_EXPORT fmi2_real_t fmi2_import_convert_to_display_unit(fmi2_real_t value , fmi2_import_display_unit_t* du, int isRelativeQuantity);
117 
118 
125 FMILIB_EXPORT fmi2_real_t fmi2_import_convert_from_display_unit(fmi2_real_t value, fmi2_import_display_unit_t* du, int isRelativeQuantity);
127 #ifdef __cplusplus
128 }
129 #endif
130 #endif
FMILIB_EXPORT fmi2_import_display_unit_t * fmi2_import_get_unit_display_unit(fmi2_import_unit_t *, size_t index)
Get a display unit object by index.
FMILIB_EXPORT const char * fmi2_import_get_unit_name(fmi2_import_unit_t *)
Get a unit name.
Library configuration file generated by the build system.
FMILIB_EXPORT const int * fmi2_import_get_SI_unit_exponents(fmi2_import_unit_t *)
Get fmi2_SI_base_units_Num SI base units exponents associated with the unit.
FMILIB_EXPORT fmi2_import_unit_t * fmi2_import_get_base_unit(fmi2_import_display_unit_t *)
Get unit defition for a display unit.
FMILIB_EXPORT unsigned int fmi2_import_get_unit_definitions_number(fmi2_import_unit_definitions_t *)
Get the number of unit definitions.
FMILIB_EXPORT unsigned int fmi2_import_get_unit_display_unit_number(fmi2_import_unit_t *)
Get the number of display units associated with this unit.
struct fmi2_xml_unit_definitions_t fmi2_import_unit_definitions_t
The list of all the unit definitions in the model.
FMILIB_EXPORT double fmi2_import_convert_from_SI_base_unit(double, fmi2_import_unit_t *)
Convert a value with respect to the SI base unit to the value with respect to the unit...
FMILIB_EXPORT double fmi2_import_convert_to_SI_base_unit(double, fmi2_import_unit_t *)
Convert a value with respect to the unit to the value with respect to the SI base unit...
#define FMILIB_EXPORT
Used to declare the public API of the library needed for dynamic linking.
FMILIB_EXPORT fmi2_real_t fmi2_import_get_display_unit_offset(fmi2_import_display_unit_t *)
Get the "offset" associated with the display unit.
FMILIB_EXPORT double fmi2_import_get_SI_unit_offset(fmi2_import_unit_t *)
Get offset to the corresponding SI base units.
struct fmi2_xml_unit_t fmi2_import_unit_t
A variable unit defined with a unit defition.
FMILIB_EXPORT fmi2_real_t fmi2_import_convert_from_display_unit(fmi2_real_t value, fmi2_import_display_unit_t *du, int isRelativeQuantity)
Convert a value measured in "display units" to a value measured with "units".
struct fmi2_xml_display_unit_t fmi2_import_display_unit_t
A display unit.
FMILIB_EXPORT fmi2_real_t fmi2_import_convert_to_display_unit(fmi2_real_t value, fmi2_import_display_unit_t *du, int isRelativeQuantity)
Convert a value measured in "units" to a value measured with "display units".
FMILIB_EXPORT const char * fmi2_import_get_display_unit_name(fmi2_import_display_unit_t *)
Get display unit name.
FMILIB_EXPORT fmi2_import_unit_t * fmi2_import_get_unit(fmi2_import_unit_definitions_t *, unsigned int index)
Get a unit definition.
FMILIB_EXPORT double fmi2_import_get_SI_unit_factor(fmi2_import_unit_t *)
Get factor to the corresponding SI base units.
FMILIB_EXPORT fmi2_real_t fmi2_import_get_display_unit_factor(fmi2_import_display_unit_t *)
Get the "factor" associated with the display unit.