FMI Library: part of JModelica.org
Functions
Functions for handling unit definitions.

Functions

FMILIB_EXPORT unsigned int fmi2_import_get_unit_definitions_number (fmi2_import_unit_definitions_t *)
 Get the number of unit definitions. More...
 
FMILIB_EXPORT fmi2_import_unit_tfmi2_import_get_unit (fmi2_import_unit_definitions_t *, unsigned int index)
 Get a unit definition. More...
 
FMILIB_EXPORT const charfmi2_import_get_unit_name (fmi2_import_unit_t *)
 Get a unit name. More...
 
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. More...
 
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. More...
 
FMILIB_EXPORT double fmi2_import_get_SI_unit_factor (fmi2_import_unit_t *)
 Get factor to the corresponding SI base units. More...
 
FMILIB_EXPORT double fmi2_import_get_SI_unit_offset (fmi2_import_unit_t *)
 Get offset to the corresponding SI base units. More...
 
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. More...
 
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. More...
 
FMILIB_EXPORT fmi2_import_display_unit_tfmi2_import_get_unit_display_unit (fmi2_import_unit_t *, size_t index)
 Get a display unit object by index. More...
 
FMILIB_EXPORT fmi2_import_unit_tfmi2_import_get_base_unit (fmi2_import_display_unit_t *)
 Get unit defition for a display unit. More...
 
FMILIB_EXPORT const charfmi2_import_get_display_unit_name (fmi2_import_display_unit_t *)
 Get display unit name. More...
 
FMILIB_EXPORT fmi2_real_t fmi2_import_get_display_unit_factor (fmi2_import_display_unit_t *)
 Get the "factor" associated with the display unit. More...
 
FMILIB_EXPORT fmi2_real_t fmi2_import_get_display_unit_offset (fmi2_import_display_unit_t *)
 Get the "offset" associated with the display unit. More...
 
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". More...
 
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". More...
 

Structures encapsulating unit information

typedef struct fmi2_xml_unit_t fmi2_import_unit_t
 A variable unit defined with a unit defition. More...
 
typedef struct fmi2_xml_display_unit_t fmi2_import_display_unit_t
 A display unit. More...
 
typedef struct fmi2_xml_unit_definitions_t fmi2_import_unit_definitions_t
 The list of all the unit definitions in the model. More...
 

Detailed Description

Typedef Documentation

typedef struct fmi2_xml_unit_t fmi2_import_unit_t

A variable unit defined with a unit defition.

Definition at line 41 of file fmi2_import_unit.h.

typedef struct fmi2_xml_display_unit_t fmi2_import_display_unit_t

A display unit.

Definition at line 43 of file fmi2_import_unit.h.

typedef struct fmi2_xml_unit_definitions_t fmi2_import_unit_definitions_t

The list of all the unit definitions in the model.

Definition at line 45 of file fmi2_import_unit.h.

Function Documentation

FMILIB_EXPORT unsigned int fmi2_import_get_unit_definitions_number ( fmi2_import_unit_definitions_t )

Get the number of unit definitions.

FMILIB_EXPORT fmi2_import_unit_t* fmi2_import_get_unit ( fmi2_import_unit_definitions_t ,
unsigned int  index 
)

Get a unit definition.

FMILIB_EXPORT const char* fmi2_import_get_unit_name ( fmi2_import_unit_t )

Get a unit name.

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.

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 double fmi2_import_get_SI_unit_factor ( fmi2_import_unit_t )

Get factor to the corresponding SI base units.

FMILIB_EXPORT double fmi2_import_get_SI_unit_offset ( fmi2_import_unit_t )

Get offset to the corresponding SI base units.

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.

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 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.

Parameters
indexThe index of display unit to be returned. Must be less than the number returned by fmi2_import_get_unit_display_unit_number()
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 const char* fmi2_import_get_display_unit_name ( fmi2_import_display_unit_t )

Get display unit name.

FMILIB_EXPORT fmi2_real_t fmi2_import_get_display_unit_factor ( fmi2_import_display_unit_t )

Get the "factor" associated with the display unit.

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 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".

Parameters
valueThe value to be converted.
duThe display unit object
isRelativeQuantityspecifies if "offset" should be incorporated into conversion
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".

Parameters
valueThe value to be converted.
duThe display unit object
isRelativeQuantityspecifies if "offset" should be incorporated into conversion