fmi2_import_type.h File Reference

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

#include "fmi2_import_unit.h"

Go to the source code of this file.

Typedefs
Type definitions supporting structures
typedef struct fmi2_xml_real_typedef_t	fmi2_import_real_typedef_t
	Opaque type definition object. More...
typedef struct fmi2_xml_integer_typedef_t	fmi2_import_integer_typedef_t
	Opaque integer type definition object. More...
typedef struct fmi2_xml_enumeration_typedef_t	fmi2_import_enumeration_typedef_t
	Opaque enumeration type definition object. More...
typedef struct fmi2_xml_variable_typedef_t	fmi2_import_variable_typedef_t
	Opaque general variable type definition object. More...
typedef struct fmi2_xml_type_definitions_t	fmi2_import_type_definitions_t
	Opaque list of the type definitions in the model. More...

Functions
FMILIB_EXPORT unsigned int	fmi2_import_get_type_definition_number (fmi2_import_type_definitions_t *td)
	Get the number of available type definitions. More...
FMILIB_EXPORT fmi2_import_variable_typedef_t *	fmi2_import_get_typedef (fmi2_import_type_definitions_t *td, unsigned int index)
	Get a type definition specified by the index. More...
FMILIB_EXPORT fmi2_import_display_unit_t *	fmi2_import_get_type_display_unit (fmi2_import_real_typedef_t *)
	Get associated display unit for a type defition if any. More...
FMILIB_EXPORT const char *	fmi2_import_get_type_name (fmi2_import_variable_typedef_t *)
	Get the type name. More...
FMILIB_EXPORT const char *	fmi2_import_get_type_description (fmi2_import_variable_typedef_t *)
	Get type description. More...
FMILIB_EXPORT fmi2_base_type_enu_t	fmi2_import_get_base_type (fmi2_import_variable_typedef_t *)
	Get base type used for the type definition. More...
FMILIB_EXPORT fmi2_import_real_typedef_t *	fmi2_import_get_type_as_real (fmi2_import_variable_typedef_t *)
	Cast the general type definition object to an object with a specific base type. More...
FMILIB_EXPORT fmi2_import_integer_typedef_t *	fmi2_import_get_type_as_int (fmi2_import_variable_typedef_t *)
	Cast the general type definition object to an object with a specific base type. More...
FMILIB_EXPORT fmi2_import_enumeration_typedef_t *	fmi2_import_get_type_as_enum (fmi2_import_variable_typedef_t *)
	Cast the general type definition object to an object with a specific base type. More...
FMILIB_EXPORT const char *	fmi2_import_get_type_quantity (fmi2_import_variable_typedef_t *)
	Get the quantity associated with the type definition. More...
FMILIB_EXPORT double	fmi2_import_get_real_type_min (fmi2_import_real_typedef_t *)
	Get minimal value for the type. More...
FMILIB_EXPORT double	fmi2_import_get_real_type_max (fmi2_import_real_typedef_t *)
	Get maximum value for the type. More...
FMILIB_EXPORT double	fmi2_import_get_real_type_nominal (fmi2_import_real_typedef_t *)
	Get the nominal value associated with the type definition. More...
FMILIB_EXPORT fmi2_import_unit_t *	fmi2_import_get_real_type_unit (fmi2_import_real_typedef_t *)
	Get the unit object associated with the type definition if any. More...
FMILIB_EXPORT int	fmi2_import_get_real_type_is_relative_quantity (fmi2_import_real_typedef_t *)
	Get the 'relativeQuantity' flag. More...
FMILIB_EXPORT int	fmi2_import_get_real_type_is_unbounded (fmi2_import_real_typedef_t *)
	Get the 'unbounded' flag. More...
FMILIB_EXPORT int	fmi2_import_get_integer_type_min (fmi2_import_integer_typedef_t *)
	Get minimal value for the type. More...
FMILIB_EXPORT int	fmi2_import_get_integer_type_max (fmi2_import_integer_typedef_t *)
	Get maximum value for the type. More...
FMILIB_EXPORT unsigned int	fmi2_import_get_enum_type_min (fmi2_import_enumeration_typedef_t *)
	Get minimal value for the type. More...
FMILIB_EXPORT unsigned int	fmi2_import_get_enum_type_max (fmi2_import_enumeration_typedef_t *)
	Get maximum value for the type. More...
FMILIB_EXPORT unsigned int	fmi2_import_get_enum_type_size (fmi2_import_enumeration_typedef_t *)
	Get the number of elements in the enum. More...
FMILIB_EXPORT const char *	fmi2_import_get_enum_type_item_name (fmi2_import_enumeration_typedef_t *, unsigned int item)
	Get an enumeration item name by index. More...
FMILIB_EXPORT int	fmi2_import_get_enum_type_item_value (fmi2_import_enumeration_typedef_t *, unsigned int item)
	Get an enumeration item value by index. More...
FMILIB_EXPORT const char *	fmi2_import_get_enum_type_item_description (fmi2_import_enumeration_typedef_t *, unsigned int item)
	Get an enumeration item description by index. More...
FMILIB_EXPORT const char *	fmi2_import_get_enum_type_value_name (fmi2_import_enumeration_typedef_t *t, int value)
	Get an enumeration item name for the given value. More...

Detailed Description

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

Definition in file fmi2_import_type.h.