FMI Library: part of JModelica.org
|
All the functions in this group take a pointer to fmi2_import_variable_t as a parameter. A variable pointer may be obtained via a Handling of variable lists module or via functions fmi2_import_get_variable_by_name() and fmi2_import_get_variable_by_vr(). More...
Scalar variable types | |
typedef struct fmi2_xml_variable_t | fmi2_import_variable_t |
General variable type. More... | |
typedef struct fmi2_xml_real_variable_t | fmi2_import_real_variable_t |
Opaque real variable. More... | |
typedef struct fmi2_xml_integer_variable_t | fmi2_import_integer_variable_t |
Opaque integer variable. More... | |
typedef struct fmi2_xml_string_variable_t | fmi2_import_string_variable_t |
Opaque string variable. More... | |
typedef struct fmi2_xml_enum_variable_t | fmi2_import_enum_variable_t |
Opaque enumeration variable. More... | |
typedef struct fmi2_xml_bool_variable_t | fmi2_import_bool_variable_t |
Opaque boolean variable. More... | |
typedef struct fmi2_import_variable_list_t | fmi2_import_variable_list_t |
List of variables. More... | |
All the functions in this group take a pointer to fmi2_import_variable_t as a parameter. A variable pointer may be obtained via a Handling of variable lists module or via functions fmi2_import_get_variable_by_name() and fmi2_import_get_variable_by_vr().
typedef struct fmi2_xml_variable_t fmi2_import_variable_t |
General variable type.
This type is convenient to unify all the variable list operations. However, typed variables are needed to support specific attributes.
Definition at line 51 of file fmi2_import_variable.h.
typedef struct fmi2_xml_real_variable_t fmi2_import_real_variable_t |
Opaque real variable.
Definition at line 53 of file fmi2_import_variable.h.
typedef struct fmi2_xml_integer_variable_t fmi2_import_integer_variable_t |
Opaque integer variable.
Definition at line 55 of file fmi2_import_variable.h.
typedef struct fmi2_xml_string_variable_t fmi2_import_string_variable_t |
Opaque string variable.
Definition at line 57 of file fmi2_import_variable.h.
typedef struct fmi2_xml_enum_variable_t fmi2_import_enum_variable_t |
Opaque enumeration variable.
Definition at line 59 of file fmi2_import_variable.h.
typedef struct fmi2_xml_bool_variable_t fmi2_import_bool_variable_t |
Opaque boolean variable.
Definition at line 61 of file fmi2_import_variable.h.
typedef struct fmi2_import_variable_list_t fmi2_import_variable_list_t |
List of variables.
Definition at line 63 of file fmi2_import_variable.h.
FMILIB_EXPORT const char* fmi2_import_get_variable_name | ( | fmi2_import_variable_t * | ) |
Get the variable name.
FMILIB_EXPORT const char* fmi2_import_get_variable_description | ( | fmi2_import_variable_t * | ) |
Get variable description.
FMILIB_EXPORT fmi2_value_reference_t fmi2_import_get_variable_vr | ( | fmi2_import_variable_t * | ) |
Get variable value reference.
FMILIB_EXPORT fmi2_import_variable_typedef_t* fmi2_import_get_variable_declared_type | ( | fmi2_import_variable_t * | ) |
For scalar variable gives the type definition is present.
FMILIB_EXPORT fmi2_base_type_enu_t fmi2_import_get_variable_base_type | ( | fmi2_import_variable_t * | ) |
Get variable base type.
FMILIB_EXPORT int fmi2_import_get_variable_has_start | ( | fmi2_import_variable_t * | ) |
Check if the variable has "start" attribute.
FMILIB_EXPORT fmi2_variability_enu_t fmi2_import_get_variability | ( | fmi2_import_variable_t * | ) |
Get variability attribute.
FMILIB_EXPORT fmi2_causality_enu_t fmi2_import_get_causality | ( | fmi2_import_variable_t * | ) |
Get causality attribute.
FMILIB_EXPORT fmi2_initial_enu_t fmi2_import_get_initial | ( | fmi2_import_variable_t * | ) |
Get initial attribute.
FMILIB_EXPORT fmi2_import_variable_t* fmi2_import_get_previous | ( | fmi2_import_variable_t * | v | ) |
Get the variable that holds the previous value of this variable, if defined.
FMILIB_EXPORT fmi2_boolean_t fmi2_import_get_canHandleMultipleSetPerTimeInstant | ( | fmi2_import_variable_t * | v | ) |
Get the canHandleMultipleSetPerTimeInstant flag for a variable.
FMILIB_EXPORT fmi2_import_real_variable_t* fmi2_import_get_variable_as_real | ( | fmi2_import_variable_t * | ) |
Cast general variable to a one with the specific type.
FMILIB_EXPORT fmi2_import_integer_variable_t* fmi2_import_get_variable_as_integer | ( | fmi2_import_variable_t * | ) |
Cast general variable to a one with the specific type.
FMILIB_EXPORT fmi2_import_enum_variable_t* fmi2_import_get_variable_as_enum | ( | fmi2_import_variable_t * | ) |
Cast general variable to a one with the specific type.
FMILIB_EXPORT fmi2_import_string_variable_t* fmi2_import_get_variable_as_string | ( | fmi2_import_variable_t * | ) |
Cast general variable to a one with the specific type.
FMILIB_EXPORT fmi2_import_bool_variable_t* fmi2_import_get_variable_as_boolean | ( | fmi2_import_variable_t * | ) |
Cast general variable to a one with the specific type.
FMILIB_EXPORT fmi2_real_t fmi2_import_get_real_variable_start | ( | fmi2_import_real_variable_t * | v | ) |
Get the variable start attribute.
FMILIB_EXPORT fmi2_import_real_variable_t* fmi2_import_get_real_variable_derivative_of | ( | fmi2_import_real_variable_t * | v | ) |
Get the variable that this is a derivative of, if defined.
FMILIB_EXPORT fmi2_boolean_t fmi2_import_get_real_variable_reinit | ( | fmi2_import_real_variable_t * | v | ) |
Get the reinit flag for a real variable.
FMILIB_EXPORT fmi2_real_t fmi2_import_get_real_variable_max | ( | fmi2_import_real_variable_t * | v | ) |
Get maximum value for the variable.
FMILIB_EXPORT fmi2_real_t fmi2_import_get_real_variable_min | ( | fmi2_import_real_variable_t * | v | ) |
Get minimal value for the variable.
FMILIB_EXPORT fmi2_real_t fmi2_import_get_real_variable_nominal | ( | fmi2_import_real_variable_t * | v | ) |
Get nominal value for the variable.
FMILIB_EXPORT fmi2_import_unit_t* fmi2_import_get_real_variable_unit | ( | fmi2_import_real_variable_t * | v | ) |
Get associated "unit" object if any.
FMILIB_EXPORT fmi2_import_display_unit_t* fmi2_import_get_real_variable_display_unit | ( | fmi2_import_real_variable_t * | v | ) |
Get associated "display unit" object if any.
FMILIB_EXPORT const char* fmi2_import_get_string_variable_start | ( | fmi2_import_string_variable_t * | v | ) |
Get start value for the variable.
FMILIB_EXPORT fmi2_boolean_t fmi2_import_get_boolean_variable_start | ( | fmi2_import_bool_variable_t * | v | ) |
Get start value for the variable.
FMILIB_EXPORT int fmi2_import_get_integer_variable_start | ( | fmi2_import_integer_variable_t * | v | ) |
Get start value for the variable.
FMILIB_EXPORT int fmi2_import_get_integer_variable_min | ( | fmi2_import_integer_variable_t * | v | ) |
Get minimal value for the variable.
FMILIB_EXPORT int fmi2_import_get_integer_variable_max | ( | fmi2_import_integer_variable_t * | v | ) |
Get max value for the variable.
FMILIB_EXPORT int fmi2_import_get_enum_variable_start | ( | fmi2_import_enum_variable_t * | v | ) |
Get start value for the variable.
FMILIB_EXPORT int fmi2_import_get_enum_variable_min | ( | fmi2_import_enum_variable_t * | v | ) |
Get minimal value for the variable.
FMILIB_EXPORT int fmi2_import_get_enum_variable_max | ( | fmi2_import_enum_variable_t * | v | ) |
Get max value for the variable.
FMILIB_EXPORT fmi2_variable_alias_kind_enu_t fmi2_import_get_variable_alias_kind | ( | fmi2_import_variable_t * | ) |
Get the variable alias kind.
FMILIB_EXPORT size_t fmi2_import_get_variable_original_order | ( | fmi2_import_variable_t * | v | ) |
Get the original index in xml of the variable.