fmi2_enums.h

Go to the documentation of this file.

/*
    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 <http://www.modelon.com>.
*/

#ifndef FMI2_ENUMS_H_
#define FMI2_ENUMS_H_

#include <fmilib_config.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum fmi2_variable_naming_convension_enu_t
{ 
        fmi2_naming_enu_flat,
        fmi2_naming_enu_structured,
        fmi2_naming_enu_unknown
} fmi2_variable_naming_convension_enu_t;

FMILIB_EXPORT const char* fmi2_naming_convention_to_string(fmi2_variable_naming_convension_enu_t convention);

typedef enum fmi2_fmu_kind_enu_t
{
                fmi2_fmu_kind_unknown = 0,
        fmi2_fmu_kind_me = 1,
        fmi2_fmu_kind_cs = 2,
        fmi2_fmu_kind_me_and_cs = 3 /* defined to be equal to (fmi2_fmu_kind_me|fmi2_fmu_kind_cs) */
} fmi2_fmu_kind_enu_t;

FMILIB_EXPORT const char* fmi2_fmu_kind_to_string(fmi2_fmu_kind_enu_t kind);

typedef enum fmi2_variability_enu_t {
        fmi2_variability_enu_constant = 0,
        fmi2_variability_enu_fixed  = 1,
        fmi2_variability_enu_tunable  = 2,
        fmi2_variability_enu_discrete  = 3,
        fmi2_variability_enu_continuous  = 4,
                fmi2_variability_enu_unknown  = 5
} fmi2_variability_enu_t;

FMILIB_EXPORT const char* fmi2_variability_to_string(fmi2_variability_enu_t v);

typedef enum fmi2_causality_enu_t {
        fmi2_causality_enu_parameter = 0,
        fmi2_causality_enu_calculated_parameter = 1,
        fmi2_causality_enu_input  = 2,
        fmi2_causality_enu_output  = 3,
        fmi2_causality_enu_local  = 4,
        fmi2_causality_enu_independent = 5,
        fmi2_causality_enu_unknown = 6
} fmi2_causality_enu_t;

FMILIB_EXPORT const char* fmi2_causality_to_string(fmi2_causality_enu_t c);

typedef enum fmi2_initial_enu_t {
        fmi2_initial_enu_exact,
        fmi2_initial_enu_approx,
        fmi2_initial_enu_calculated,
        fmi2_initial_enu_unknown /* must be last*/
} fmi2_initial_enu_t;

FMILIB_EXPORT const char* fmi2_initial_to_string(fmi2_initial_enu_t c);

FMILIB_EXPORT fmi2_initial_enu_t fmi2_get_default_initial(fmi2_variability_enu_t v, fmi2_causality_enu_t c);

FMILIB_EXPORT fmi2_initial_enu_t fmi2_get_valid_initial(fmi2_variability_enu_t v, fmi2_causality_enu_t c, fmi2_initial_enu_t i);

typedef enum fmi2_variable_alias_kind_enu_t {
    fmi2_variable_is_not_alias = 0,
    fmi2_variable_is_alias = 1
} fmi2_variable_alias_kind_enu_t;

typedef enum fmi2_base_type_enu_t
{
        fmi2_base_type_real,
        fmi2_base_type_int,
        fmi2_base_type_bool,
        fmi2_base_type_str,
        fmi2_base_type_enum
} fmi2_base_type_enu_t;

FMILIB_EXPORT const char* fmi2_base_type_to_string(fmi2_base_type_enu_t bt);

#define FMI2_ME_CAPABILITIES(H) \
        H(needsExecutionTool) \
        H(completedIntegratorStepNotNeeded) \
        H(canBeInstantiatedOnlyOncePerProcess) \
        H(canNotUseMemoryManagementFunctions) \
        H(canGetAndSetFMUstate) \
        H(canSerializeFMUstate) \
        H(providesDirectionalDerivatives)\
        H(completedEventIterationIsProvided)

#define FMI2_CS_CAPABILITIES(H) \
        H(needsExecutionTool) \
        H(canHandleVariableCommunicationStepSize) \
        H(canInterpolateInputs) \
        H(maxOutputDerivativeOrder) \
        H(canRunAsynchronuously) \
        H(canBeInstantiatedOnlyOncePerProcess) \
        H(canNotUseMemoryManagementFunctions) \
        H(canGetAndSetFMUstate) \
        H(canSerializeFMUstate) \
        H(providesDirectionalDerivatives)

typedef enum fmi2_capabilities_enu_t {
#define FMI2_EXPAND_ME_CAPABILITIES_ENU(c) fmi2_me_ ## c,
#define FMI2_EXPAND_CS_CAPABILITIES_ENU(c) fmi2_cs_ ## c,
        FMI2_ME_CAPABILITIES(FMI2_EXPAND_ME_CAPABILITIES_ENU)
        FMI2_CS_CAPABILITIES(FMI2_EXPAND_CS_CAPABILITIES_ENU)
        fmi2_capabilities_Num
} fmi2_capabilities_enu_t;

FMILIB_EXPORT const char * fmi2_capability_to_string(fmi2_capabilities_enu_t id);

#define FMI2_SI_BASE_UNITS(H) \
        H(kg) H(m) H(s) H(A) H(K) H(mol) H(cd) H(rad)

typedef enum fmi2_SI_base_units_enu_t {
#define FMI2_EXPAND_SI_BASE_UNIT_ENU(c) fmi2_SI_base_unit_ ## c,
        FMI2_SI_BASE_UNITS(FMI2_EXPAND_SI_BASE_UNIT_ENU)
        fmi2_SI_base_units_Num
} fmi2_SI_base_units_enu_t;

FMILIB_EXPORT const char * fmi2_SI_base_unit_to_string(fmi2_SI_base_units_enu_t id);

FMILIB_EXPORT size_t fmi2_SI_base_unit_exp_to_string(const int exp[fmi2_SI_base_units_Num], size_t bufSize, char buf[]);


typedef enum fmi2_dependency_factor_kind_enu_t
{
        fmi2_dependency_factor_kind_dependent = 0,
        fmi2_dependency_factor_kind_constant,
        fmi2_dependency_factor_kind_fixed,
        fmi2_dependency_factor_kind_tunable,
        fmi2_dependency_factor_kind_discrete,
        fmi2_dependency_factor_kind_num
} fmi2_dependency_factor_kind_enu_t;

FMILIB_EXPORT const char* fmi2_dependency_factor_kind_to_string(fmi2_dependency_factor_kind_enu_t fc);
#ifdef __cplusplus
}
#endif

#endif /* End of header file FMI2_ENUMS_H_ */