/* Copyright (C) 2012 Modelon AB This program is free software: you can redistribute it and/or modify it under the terms of the BSD style license. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the FMILIB_License.txt file for more details. You should have received a copy of the FMILIB_License.txt file along with this program. If not, contact Modelon AB . */ /** \file fmi1_import_variable.h * \brief Public interface to the FMI import C-library. Handling of model variables. */ #ifndef FMI1_IMPORT_VARIABLE_H_ #define FMI1_IMPORT_VARIABLE_H_ #include #include "fmi1_import_type.h" #include "fmi1_import_unit.h" #ifdef __cplusplus extern "C" { #endif /** \addtogroup fmi1_import @{ \addtogroup fmi1_import_variables Functions for handling variable definitions. @} \addtogroup fmi1_import_variables Functions for handling variable definitions. \brief All the functions in this group take a pointer to ::fmi1_import_variable_t as a parameter. A variable pointer may be obtained via a \ref fmi1_import_varlist module or via functions fmi1_import_get_variable_by_name() and fmi1_import_get_variable_by_vr(). @{ */ /**@name Scalar variable types */ /**@{ */ /** \brief General variable type. * * This type is convenient to unify all the variable list operations. * However, typed variables are needed to support specific attributes. */ typedef struct fmi1_xml_variable_t fmi1_import_variable_t; /** \brief Opaque real variable */ typedef struct fmi1_xml_real_variable_t fmi1_import_real_variable_t; /** \brief Opaque integer variable */ typedef struct fmi1_xml_integer_variable_t fmi1_import_integer_variable_t; /** \brief Opaque string variable */ typedef struct fmi1_xml_string_variable_t fmi1_import_string_variable_t; /** \brief Opaque enumeration variable */ typedef struct fmi1_xml_enum_variable_t fmi1_import_enum_variable_t; /** \brief Opaque boolean variable */ typedef struct fmi1_xml_bool_variable_t fmi1_import_bool_variable_t; /** \brief List of variables */ typedef struct fmi1_import_variable_list_t fmi1_import_variable_list_t; /**@} */ /** \brief Get variable by variable name. \param fmu - An fmu object as returned by fmi1_import_parse_xml(). \param name - variable name \return variable pointer. */ FMILIB_EXPORT fmi1_import_variable_t* fmi1_import_get_variable_by_name(fmi1_import_t* fmu, const char* name); /** \brief Get variable by value reference. \param fmu - An fmu object as returned by fmi1_import_parse_xml(). \param baseType - basic data type \param vr - value reference \return variable pointer. */ FMILIB_EXPORT fmi1_import_variable_t* fmi1_import_get_variable_by_vr(fmi1_import_t* fmu, fmi1_base_type_enu_t baseType, fmi1_value_reference_t vr); /** \brief Get the variable name */ FMILIB_EXPORT const char* fmi1_import_get_variable_name(fmi1_import_variable_t*); /** \brief Get variable description. @return Description string or empty string ("") if no description in the XML file was given. */ FMILIB_EXPORT const char* fmi1_import_get_variable_description(fmi1_import_variable_t*); /** \brief Get variable value reference */ FMILIB_EXPORT fmi1_value_reference_t fmi1_import_get_variable_vr(fmi1_import_variable_t*); /** \brief For scalar variable gives the type definition is present @return Pointer of a type #fmi1_import_variable_typedef_t object or NULL of not present. */ FMILIB_EXPORT fmi1_import_variable_typedef_t* fmi1_import_get_variable_declared_type(fmi1_import_variable_t*); /** \brief Get variable base type */ FMILIB_EXPORT fmi1_base_type_enu_t fmi1_import_get_variable_base_type(fmi1_import_variable_t*); /** \brief Check if the variable has "start" attribute */ FMILIB_EXPORT int fmi1_import_get_variable_has_start(fmi1_import_variable_t*); /** \brief Get the variable "fixed" attribute */ FMILIB_EXPORT int fmi1_import_get_variable_is_fixed(fmi1_import_variable_t*); /** \brief Get variability attribute */ FMILIB_EXPORT fmi1_variability_enu_t fmi1_import_get_variability(fmi1_import_variable_t*); /** \brief Get causality attribute */ FMILIB_EXPORT fmi1_causality_enu_t fmi1_import_get_causality(fmi1_import_variable_t*); /** \brief Cast general variable to a one with the specific type @return Typed object or NULL if base type does not match */ FMILIB_EXPORT fmi1_import_real_variable_t* fmi1_import_get_variable_as_real(fmi1_import_variable_t*); /** \brief Cast general variable to a one with the specific type @return Typed object or NULL if base type does not match */ FMILIB_EXPORT fmi1_import_integer_variable_t* fmi1_import_get_variable_as_integer(fmi1_import_variable_t*); /** \brief Cast general variable to a one with the specific type @return Typed object or NULL if base type does not match */ FMILIB_EXPORT fmi1_import_enum_variable_t* fmi1_import_get_variable_as_enum(fmi1_import_variable_t*); /** \brief Cast general variable to a one with the specific type @return Typed object or NULL if base type does not match */ FMILIB_EXPORT fmi1_import_string_variable_t* fmi1_import_get_variable_as_string(fmi1_import_variable_t*); /** \brief Cast general variable to a one with the specific type @return Typed object or NULL if base type does not match */ FMILIB_EXPORT fmi1_import_bool_variable_t* fmi1_import_get_variable_as_boolean(fmi1_import_variable_t*); /** \brief Get the variable start attribute. @return The "start" attriburte as specified in the XML file or variable nominal value. */ FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_start(fmi1_import_real_variable_t* v); /** \brief Get maximum value for the variable @return Either the value specified in the XML file or DBL_MAX as defined in */ FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_max(fmi1_import_real_variable_t* v); /** \brief Get minimal value for the variable. @return Either the value specified in the XML file or negated DBL_MAX as defined in */ FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_min(fmi1_import_real_variable_t* v); /** \brief Get nominal value for the variable*/ FMILIB_EXPORT fmi1_real_t fmi1_import_get_real_variable_nominal(fmi1_import_real_variable_t* v); /** \brief Get associated "unit" object if any */ FMILIB_EXPORT fmi1_import_unit_t* fmi1_import_get_real_variable_unit(fmi1_import_real_variable_t* v); /** \brief Get associated "display unit" object if any */ FMILIB_EXPORT fmi1_import_display_unit_t* fmi1_import_get_real_variable_display_unit(fmi1_import_real_variable_t* v); /** \brief Get start value for the variable */ FMILIB_EXPORT const char* fmi1_import_get_string_variable_start(fmi1_import_string_variable_t* v); /** \brief Get start value for the variable */ FMILIB_EXPORT fmi1_boolean_t fmi1_import_get_boolean_variable_start(fmi1_import_bool_variable_t* v); /** \brief Get start value for the variable*/ FMILIB_EXPORT int fmi1_import_get_integer_variable_start(fmi1_import_integer_variable_t* v); /** \brief Get minimal value for the variable */ FMILIB_EXPORT int fmi1_import_get_integer_variable_min(fmi1_import_integer_variable_t* v); /** \brief Get max value for the variable */ FMILIB_EXPORT int fmi1_import_get_integer_variable_max(fmi1_import_integer_variable_t* v); /** \brief Get start value for the variable*/ FMILIB_EXPORT int fmi1_import_get_enum_variable_start(fmi1_import_enum_variable_t* v); /** \brief Get minimal value for the variable */ FMILIB_EXPORT int fmi1_import_get_enum_variable_min(fmi1_import_enum_variable_t* v); /** \brief Get max value for the variable */ FMILIB_EXPORT int fmi1_import_get_enum_variable_max(fmi1_import_enum_variable_t* v); /** \brief Get the variable alias kind*/ FMILIB_EXPORT fmi1_variable_alias_kind_enu_t fmi1_import_get_variable_alias_kind(fmi1_import_variable_t*); /** \brief Get the original index in xml of the variable */ size_t fmi1_import_get_variable_original_order(fmi1_import_variable_t* v); /** @} */ #ifdef __cplusplus } #endif #endif