fmi1_import_type.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 FMI1_IMPORT_TYPE_H_
#define FMI1_IMPORT_TYPE_H_

#include "fmi1_import_unit.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct fmi1_xml_real_typedef_t fmi1_import_real_typedef_t;
typedef struct fmi1_xml_integer_typedef_t fmi1_import_integer_typedef_t;
typedef struct fmi1_xml_enumeration_typedef_t fmi1_import_enumeration_typedef_t;
typedef struct fmi1_xml_variable_typedef_t fmi1_import_variable_typedef_t;
typedef struct fmi1_xml_type_definitions_t fmi1_import_type_definitions_t;
FMILIB_EXPORT size_t fmi1_import_get_type_definition_number(fmi1_import_type_definitions_t* td);

FMILIB_EXPORT fmi1_import_variable_typedef_t* fmi1_import_get_typedef(fmi1_import_type_definitions_t* td, unsigned int  index);

FMILIB_EXPORT fmi1_import_display_unit_t* fmi1_import_get_type_display_unit(fmi1_import_real_typedef_t*);

FMILIB_EXPORT const char* fmi1_import_get_type_name(fmi1_import_variable_typedef_t*);

FMILIB_EXPORT const char* fmi1_import_get_type_description(fmi1_import_variable_typedef_t*);

FMILIB_EXPORT fmi1_base_type_enu_t fmi1_import_get_base_type(fmi1_import_variable_typedef_t*);

/* Boolean and String has no extra attributes -> not needed*/

FMILIB_EXPORT fmi1_import_real_typedef_t* fmi1_import_get_type_as_real(fmi1_import_variable_typedef_t*);
FMILIB_EXPORT fmi1_import_integer_typedef_t* fmi1_import_get_type_as_int(fmi1_import_variable_typedef_t*);
FMILIB_EXPORT fmi1_import_enumeration_typedef_t* fmi1_import_get_type_as_enum(fmi1_import_variable_typedef_t*);

FMILIB_EXPORT const char* fmi1_import_get_type_quantity(fmi1_import_variable_typedef_t*);

FMILIB_EXPORT double fmi1_import_get_real_type_min(fmi1_import_real_typedef_t*);
FMILIB_EXPORT double fmi1_import_get_real_type_max(fmi1_import_real_typedef_t*);

FMILIB_EXPORT double fmi1_import_get_real_type_nominal(fmi1_import_real_typedef_t*);

FMILIB_EXPORT fmi1_import_unit_t* fmi1_import_get_real_type_unit(fmi1_import_real_typedef_t*);

FMILIB_EXPORT int fmi1_import_get_real_type_is_relative_quantity(fmi1_import_real_typedef_t*);

FMILIB_EXPORT int fmi1_import_get_integer_type_min(fmi1_import_integer_typedef_t*);
FMILIB_EXPORT int fmi1_import_get_integer_type_max(fmi1_import_integer_typedef_t*);

FMILIB_EXPORT unsigned int fmi1_import_get_enum_type_min(fmi1_import_enumeration_typedef_t*);

FMILIB_EXPORT unsigned int fmi1_import_get_enum_type_max(fmi1_import_enumeration_typedef_t*);

FMILIB_EXPORT unsigned int  fmi1_import_get_enum_type_size(fmi1_import_enumeration_typedef_t*);

FMILIB_EXPORT const char* fmi1_import_get_enum_type_item_name(fmi1_import_enumeration_typedef_t*, unsigned int  item);
FMILIB_EXPORT const char* fmi1_import_get_enum_type_item_description(fmi1_import_enumeration_typedef_t*, unsigned int  item);

FMILIB_EXPORT fmi1_import_display_unit_t* fmi1_import_get_type_display_unit(fmi1_import_real_typedef_t*);

#ifdef __cplusplus
}
#endif
#endif