FMI 1.0 (ME & CS) Common functions

List of wrapper functions that are in common for both Model Exchange and Co-Simulation. More...

Functions
FMILIB_EXPORT const char *	fmi1_import_get_version (fmi1_import_t *fmu)
	Wrapper for the FMI function fmiGetVersion() More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_set_debug_logging (fmi1_import_t *fmu, fmi1_boolean_t loggingOn)
	Wrapper for the FMI function fmiSetDebugLogging(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_set_real (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_real_t value[])
	Wrapper for the FMI function fmiSetReal(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_set_integer (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t value[])
	Wrapper for the FMI function fmiSetInteger(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_set_boolean (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_boolean_t value[])
	Wrapper for the FMI function fmiSetBoolean(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_set_string (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_string_t value[])
	Wrapper for the FMI function fmiSetString(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_get_real (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_real_t value[])
	Wrapper for the FMI function fmiGetReal(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_get_integer (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_integer_t value[])
	Wrapper for the FMI function fmiGetInteger(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_get_boolean (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_boolean_t value[])
	Wrapper for the FMI function fmiGetBoolean(...) More...
FMILIB_EXPORT fmi1_status_t	fmi1_import_get_string (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, fmi1_string_t value[])
	Wrapper for the FMI function fmiGetString(...) More...

Detailed Description

List of wrapper functions that are in common for both Model Exchange and Co-Simulation.

Function Documentation

FMILIB_EXPORT const char* fmi1_import_get_version

(

fmi1_import_t *

fmu

)

Wrapper for the FMI function fmiGetVersion()

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().

Returns

FMI version.

FMILIB_EXPORT fmi1_status_t fmi1_import_set_debug_logging	(	fmi1_import_t *	fmu,
		fmi1_boolean_t	loggingOn
	)

Wrapper for the FMI function fmiSetDebugLogging(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
loggingOn	Enable or disable the debug logger.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_set_real	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		const fmi1_real_t	value[]
	)

Wrapper for the FMI function fmiSetReal(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	Array of variable values.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_set_integer	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		const fmi1_integer_t	value[]
	)

Wrapper for the FMI function fmiSetInteger(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	Array of variable values.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_set_boolean	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		const fmi1_boolean_t	value[]
	)

Wrapper for the FMI function fmiSetBoolean(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	Array of variable values.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_set_string	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		const fmi1_string_t	value[]
	)

Wrapper for the FMI function fmiSetString(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	Array of variable values.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_real	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		fmi1_real_t	value[]
	)

Wrapper for the FMI function fmiGetReal(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	(Output)Array of variable values.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_integer	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		fmi1_integer_t	value[]
	)

Wrapper for the FMI function fmiGetInteger(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	(Output)Array of variable values.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_boolean	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		fmi1_boolean_t	value[]
	)

Wrapper for the FMI function fmiGetBoolean(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	(Output)Array of variable values.

Returns

FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_string	(	fmi1_import_t *	fmu,
		const fmi1_value_reference_t	vr[],
		size_t	nvr,
		fmi1_string_t	value[]
	)

Wrapper for the FMI function fmiGetString(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
vr	Array of value references.
nvr	Number of array elements.
value	(Output)Array of variable values.

Returns

FMI status.