fmi2_import.h File Reference

Public interface to the FMI import C-library. More...

#include <stddef.h>
#include <fmilib_config.h>
#include <JM/jm_callbacks.h>
#include <FMI/fmi_import_util.h>
#include <FMI/fmi_import_context.h>
#include <FMI2/fmi2_types.h>
#include <FMI2/fmi2_functions.h>
#include <FMI2/fmi2_enums.h>
#include "fmi2_import_type.h"
#include "fmi2_import_unit.h"
#include "fmi2_import_variable.h"
#include "fmi2_import_variable_list.h"
#include "fmi2_import_capi.h"
#include "fmi2_import_convenience.h"

Go to the source code of this file.

Functions
FMILIB_EXPORT const char *	fmi2_import_get_last_error (fmi2_import_t *fmu)
	Retrieve the last error message. More...
FMILIB_EXPORT int	fmi2_import_clear_last_error (fmi2_import_t *fmu)
	Clear the error message. More...
FMILIB_EXPORT void	fmi2_import_free (fmi2_import_t *fmu)
	Release the memory allocated. More...
FMILIB_EXPORT const char *	fmi2_import_get_model_name (fmi2_import_t *fmu)
	Get model name. More...
FMILIB_EXPORT unsigned int	fmi2_import_get_capability (fmi2_import_t *, fmi2_capabilities_enu_t id)
	Retrieve capability flags by ID. More...
FMILIB_EXPORT const char *	fmi2_import_get_model_identifier_ME (fmi2_import_t *fmu)
	Get model identifier for ModelExchange. More...
FMILIB_EXPORT const char *	fmi2_import_get_model_identifier_CS (fmi2_import_t *fmu)
	Get model identifier for CoSimulation. More...
FMILIB_EXPORT const char *	fmi2_import_get_GUID (fmi2_import_t *fmu)
	Get FMU GUID. More...
FMILIB_EXPORT const char *	fmi2_import_get_description (fmi2_import_t *fmu)
	Get FMU description. More...
FMILIB_EXPORT const char *	fmi2_import_get_author (fmi2_import_t *fmu)
	Get FMU author. More...
FMILIB_EXPORT const char *	fmi2_import_get_copyright (fmi2_import_t *fmu)
	Get FMU copyright information. More...
FMILIB_EXPORT const char *	fmi2_import_get_license (fmi2_import_t *fmu)
	Get FMU license information. More...
FMILIB_EXPORT const char *	fmi2_import_get_model_version (fmi2_import_t *fmu)
	Get FMU version. More...
FMILIB_EXPORT const char *	fmi2_import_get_model_standard_version (fmi2_import_t *fmu)
	Get FMI standard version (always 2.0). More...
FMILIB_EXPORT const char *	fmi2_import_get_generation_tool (fmi2_import_t *fmu)
	Get FMU generation tool. More...
FMILIB_EXPORT const char *	fmi2_import_get_generation_date_and_time (fmi2_import_t *fmu)
	Get FMU generation date and time. More...
FMILIB_EXPORT fmi2_variable_naming_convension_enu_t	fmi2_import_get_naming_convention (fmi2_import_t *fmu)
	Get variable naming convention used. More...
FMILIB_EXPORT size_t	fmi2_import_get_number_of_continuous_states (fmi2_import_t *fmu)
	Get the number of continuous states. More...
FMILIB_EXPORT size_t	fmi2_import_get_number_of_event_indicators (fmi2_import_t *fmu)
	Get the number of event indicators. More...
FMILIB_EXPORT double	fmi2_import_get_default_experiment_start (fmi2_import_t *fmu)
	Get the start time for default experiment as specified in the XML file. More...
FMILIB_EXPORT double	fmi2_import_get_default_experiment_stop (fmi2_import_t *fmu)
	Get the stop time for default experiment as specified in the XML file. More...
FMILIB_EXPORT double	fmi2_import_get_default_experiment_tolerance (fmi2_import_t *fmu)
	Get the tolerance for default experiment as specified in the XML file. More...
FMILIB_EXPORT double	fmi2_import_get_default_experiment_step (fmi2_import_t *fmu)
	Get the step size for default experiment as specified in the XML file. More...
FMILIB_EXPORT fmi2_fmu_kind_enu_t	fmi2_import_get_fmu_kind (fmi2_import_t *fmu)
	Get the type of the FMU (model exchange or co-simulation) More...
FMILIB_EXPORT fmi2_import_type_definitions_t *	fmi2_import_get_type_definitions (fmi2_import_t *)
	Get the list of all the type definitions in the model. More...
FMILIB_EXPORT fmi2_import_unit_definitions_t *	fmi2_import_get_unit_definitions (fmi2_import_t *fmu)
	Get a list of all the unit definitions in the model. More...
FMILIB_EXPORT fmi2_import_variable_t *	fmi2_import_get_variable_alias_base (fmi2_import_t *fmu, fmi2_import_variable_t *)
	Get the variable with the same value reference that is not an alias. More...
FMILIB_EXPORT fmi2_import_variable_list_t *	fmi2_import_get_variable_aliases (fmi2_import_t *fmu, fmi2_import_variable_t *)
FMILIB_EXPORT fmi2_import_variable_list_t *	fmi2_import_get_variable_list (fmi2_import_t *fmu, int sortOrder)
	Get the list of all the variables in the model. More...
FMILIB_EXPORT fmi2_import_variable_list_t *	fmi2_import_create_var_list (fmi2_import_t *fmu, fmi2_import_variable_t *v)
	Create a variable list with a single variable. More...
FMILIB_EXPORT size_t	fmi2_import_get_vendors_num (fmi2_import_t *fmu)
	Get the number of vendors that had annotations in the XML. More...
FMILIB_EXPORT const char *	fmi2_import_get_vendor_name (fmi2_import_t *fmu, size_t index)
	Get the name of the vendor with that had annotations in the XML by index. More...
FMILIB_EXPORT size_t	fmi2_import_get_log_categories_num (fmi2_import_t *fmu)
	Get the number of log categories defined in the XML. More...
FMILIB_EXPORT const char *	fmi2_import_get_log_category (fmi2_import_t *fmu, size_t index)
	Get the log category by index. More...
FMILIB_EXPORT const char *	fmi2_import_get_log_category_description (fmi2_import_t *fmu, size_t index)
	Get the log category description by index. More...
FMILIB_EXPORT size_t	fmi2_import_get_source_files_me_num (fmi2_import_t *fmu)
	Get the number of source files for ME defined in the XML. More...
FMILIB_EXPORT const char *	fmi2_import_get_source_file_me (fmi2_import_t *fmu, size_t index)
	Get the ME source file by index. More...
FMILIB_EXPORT size_t	fmi2_import_get_source_files_cs_num (fmi2_import_t *fmu)
	Get the number of source files for CS defined in the XML. More...
FMILIB_EXPORT const char *	fmi2_import_get_source_file_cs (fmi2_import_t *fmu, size_t index)
	Get the CS source file by index. More...
FMILIB_EXPORT fmi2_import_variable_t *	fmi2_import_get_variable_by_name (fmi2_import_t *fmu, const char *name)
	Get variable by variable name. More...
FMILIB_EXPORT fmi2_import_variable_t *	fmi2_import_get_variable_by_vr (fmi2_import_t *fmu, fmi2_base_type_enu_t baseType, fmi2_value_reference_t vr)
	Get variable by value reference. More...
FMILIB_EXPORT fmi2_import_variable_list_t *	fmi2_import_get_outputs_list (fmi2_import_t *fmu)
	Get the list of all the output variables in the model. More...
FMILIB_EXPORT fmi2_import_variable_list_t *	fmi2_import_get_derivatives_list (fmi2_import_t *fmu)
	Get the list of all the derivative variables in the model. More...
FMILIB_EXPORT fmi2_import_variable_list_t *	fmi2_import_get_discrete_states_list (fmi2_import_t *fmu)
	Get the list of all the discrete state variables in the model. More...
FMILIB_EXPORT fmi2_import_variable_list_t *	fmi2_import_get_initial_unknowns_list (fmi2_import_t *fmu)
	Get the list of all the initial unknown variables in the model. More...
FMILIB_EXPORT void	fmi2_import_get_outputs_dependencies (fmi2_import_t *fmu, size_t **startIndex, size_t **dependency, char **factorKind)
	Get dependency information in row-compressed format. More...
FMILIB_EXPORT void	fmi2_import_get_derivatives_dependencies (fmi2_import_t *fmu, size_t **startIndex, size_t **dependency, char **factorKind)
	Get dependency information in row-compressed format. More...
FMILIB_EXPORT void	fmi2_import_get_discrete_states_dependencies (fmi2_import_t *fmu, size_t **startIndex, size_t **dependency, char **factorKind)
	Get dependency information in row-compressed format. More...
FMILIB_EXPORT void	fmi2_import_get_initial_unknowns_dependencies (fmi2_import_t *fmu, size_t **startIndex, size_t **dependency, char **factorKind)
	Get dependency information in row-compressed format. More...

Detailed Description

Public interface to the FMI import C-library.

Definition in file fmi2_import.h.