FMI Library: part of JModelica.org
Functions
fmi1_import_type.h File Reference

Public interface to the FMI XML C-library: variable types handling. More...

#include "fmi1_import_unit.h"

Go to the source code of this file.

Typedefs

Type definitions supporting structures
typedef struct fmi1_xml_real_typedef_t fmi1_import_real_typedef_t
 Opaque type definition object. More...
 
typedef struct fmi1_xml_integer_typedef_t fmi1_import_integer_typedef_t
 Opaque integer type definition object. More...
 
typedef struct fmi1_xml_enumeration_typedef_t fmi1_import_enumeration_typedef_t
 Opaque enumeration type definition object. More...
 
typedef struct fmi1_xml_variable_typedef_t fmi1_import_variable_typedef_t
 Opaque general variable type definition object. More...
 
typedef struct fmi1_xml_type_definitions_t fmi1_import_type_definitions_t
 Opaque list of the type definitions in the model. More...
 

Functions

FMILIB_EXPORT size_t fmi1_import_get_type_definition_number (fmi1_import_type_definitions_t *td)
 Get the number of available type definitions. More...
 
FMILIB_EXPORT fmi1_import_variable_typedef_tfmi1_import_get_typedef (fmi1_import_type_definitions_t *td, unsigned int index)
 Get a type definition specified by the index. More...
 
FMILIB_EXPORT fmi1_import_display_unit_tfmi1_import_get_type_display_unit (fmi1_import_real_typedef_t *)
 Get associated display unit for a type defition if any. More...
 
FMILIB_EXPORT const charfmi1_import_get_type_name (fmi1_import_variable_typedef_t *)
 Get the type name. More...
 
FMILIB_EXPORT const charfmi1_import_get_type_description (fmi1_import_variable_typedef_t *)
 Get type description. More...
 
FMILIB_EXPORT fmi1_base_type_enu_t fmi1_import_get_base_type (fmi1_import_variable_typedef_t *)
 Get base type used for the type definition. More...
 
FMILIB_EXPORT fmi1_import_real_typedef_tfmi1_import_get_type_as_real (fmi1_import_variable_typedef_t *)
 Cast the general type definition object to an object with a specific base type. More...
 
FMILIB_EXPORT fmi1_import_integer_typedef_tfmi1_import_get_type_as_int (fmi1_import_variable_typedef_t *)
 Cast the general type definition object to an object with a specific base type. More...
 
FMILIB_EXPORT fmi1_import_enumeration_typedef_tfmi1_import_get_type_as_enum (fmi1_import_variable_typedef_t *)
 Cast the general type definition object to an object with a specific base type. More...
 
FMILIB_EXPORT const charfmi1_import_get_type_quantity (fmi1_import_variable_typedef_t *)
 Get the quantity associated with the type definition. More...
 
FMILIB_EXPORT double fmi1_import_get_real_type_min (fmi1_import_real_typedef_t *)
 Get minimal value for the type. More...
 
FMILIB_EXPORT double fmi1_import_get_real_type_max (fmi1_import_real_typedef_t *)
 Get maximum value for the type. More...
 
FMILIB_EXPORT double fmi1_import_get_real_type_nominal (fmi1_import_real_typedef_t *)
 Get the nominal value associated with the type definition. More...
 
FMILIB_EXPORT fmi1_import_unit_tfmi1_import_get_real_type_unit (fmi1_import_real_typedef_t *)
 Get the unit object associated with the type definition if any. More...
 
FMILIB_EXPORT int fmi1_import_get_real_type_is_relative_quantity (fmi1_import_real_typedef_t *)
 Get the relativeQuantity flag. More...
 
FMILIB_EXPORT int fmi1_import_get_integer_type_min (fmi1_import_integer_typedef_t *)
 Get minimal value for the type. More...
 
FMILIB_EXPORT int fmi1_import_get_integer_type_max (fmi1_import_integer_typedef_t *)
 Get maximum value for the type. More...
 
FMILIB_EXPORT unsigned int fmi1_import_get_enum_type_min (fmi1_import_enumeration_typedef_t *)
 Get minimal value for the type. More...
 
FMILIB_EXPORT unsigned int fmi1_import_get_enum_type_max (fmi1_import_enumeration_typedef_t *)
 Get maximum value for the type. More...
 
FMILIB_EXPORT unsigned int fmi1_import_get_enum_type_size (fmi1_import_enumeration_typedef_t *)
 Get the number of elements in the enum. More...
 
FMILIB_EXPORT const charfmi1_import_get_enum_type_item_name (fmi1_import_enumeration_typedef_t *, unsigned int item)
 Get an enumeration item name by index. More...
 
FMILIB_EXPORT const charfmi1_import_get_enum_type_item_description (fmi1_import_enumeration_typedef_t *, unsigned int item)
 Get an enumeration item description by index. More...
 

Detailed Description

Public interface to the FMI XML C-library: variable types handling.

Definition in file fmi1_import_type.h.