List of Co-Simulation wrapper functions. Common functions are not listed. More...

Functions
FMILIB_EXPORT fmi2_status_t	fmi2_import_set_real_input_derivatives (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t order[], const fmi2_real_t value[])
	Wrapper for the FMI function fmiSetRealInputDerivatives(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_get_real_output_derivatives (fmi2_import_t *fmu, const fmi2_value_reference_t vr[], size_t nvr, const fmi2_integer_t order[], fmi2_real_t value[])
	Wrapper for the FMI function fmiGetOutputDerivatives(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_cancel_step (fmi2_import_t *fmu)
	Wrapper for the FMI function fmiCancelStep(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_do_step (fmi2_import_t *fmu, fmi2_real_t currentCommunicationPoint, fmi2_real_t communicationStepSize, fmi2_boolean_t newStep)
	Wrapper for the FMI function fmiDoStep(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_get_status (fmi2_import_t fmu, const fmi2_status_kind_t s, fmi2_status_t value)
	Wrapper for the FMI function fmiGetStatus(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_get_real_status (fmi2_import_t fmu, const fmi2_status_kind_t s, fmi2_real_t value)
	Wrapper for the FMI function fmiGetRealStatus(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_get_integer_status (fmi2_import_t fmu, const fmi2_status_kind_t s, fmi2_integer_t value)
	Wrapper for the FMI function fmiGetIntegerStatus(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_get_boolean_status (fmi2_import_t fmu, const fmi2_status_kind_t s, fmi2_boolean_t value)
	Wrapper for the FMI function fmiGetBooleanStatus(...) More...

FMILIB_EXPORT fmi2_status_t	fmi2_import_get_string_status (fmi2_import_t fmu, const fmi2_status_kind_t s, fmi2_string_t value)
	Wrapper for the FMI function fmiGetStringStatus(...) More...

Detailed Description

List of Co-Simulation wrapper functions. Common functions are not listed.

Function Documentation

FMILIB_EXPORT fmi2_status_t fmi2_import_set_real_input_derivatives	(	fmi2_import_t *	fmu,
		const fmi2_value_reference_t	vr[],
		size_t	nvr,
		const fmi2_integer_t	order[],
		const fmi2_real_t	value[]
	)

Wrapper for the FMI function fmiSetRealInputDerivatives(...)

Parameters

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

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_real_output_derivatives	(	fmi2_import_t *	fmu,
		const fmi2_value_reference_t	vr[],
		size_t	nvr,
		const fmi2_integer_t	order[],
		fmi2_real_t	value[]
	)

Wrapper for the FMI function fmiGetOutputDerivatives(...)

Parameters

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

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_cancel_step ( fmi2_import_t * fmu )

Wrapper for the FMI function fmiCancelStep(...)

Parameters

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

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_do_step	(	fmi2_import_t *	fmu,
		fmi2_real_t	currentCommunicationPoint,
		fmi2_real_t	communicationStepSize,
		fmi2_boolean_t	newStep
	)

Wrapper for the FMI function fmiDoStep(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
currentCommunicationPoint	Current communication point of the master.
communicationStepSize	Communication step size.
newStep	Indicates whether or not the last communication step was accepted by the master.

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_status	(	fmi2_import_t *	fmu,
		const fmi2_status_kind_t	s,
		fmi2_status_t *	value
	)

Wrapper for the FMI function fmiGetStatus(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
s	Kind of status to return the value for.
value	(Output) FMI status value.

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_real_status	(	fmi2_import_t *	fmu,
		const fmi2_status_kind_t	s,
		fmi2_real_t *	value
	)

Wrapper for the FMI function fmiGetRealStatus(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
s	Kind of status to return the value for.
value	(Output) FMI real value.

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_integer_status	(	fmi2_import_t *	fmu,
		const fmi2_status_kind_t	s,
		fmi2_integer_t *	value
	)

Wrapper for the FMI function fmiGetIntegerStatus(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu.
s	Kind of status to return the value for.
value	(Output) FMI integer value.

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_boolean_status	(	fmi2_import_t *	fmu,
		const fmi2_status_kind_t	s,
		fmi2_boolean_t *	value
	)

Wrapper for the FMI function fmiGetBooleanStatus(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu.
s	Kind of status to return the value for.
value	(Output) FMI boolean value.

Returns: FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_string_status	(	fmi2_import_t *	fmu,
		const fmi2_status_kind_t	s,
		fmi2_string_t *	value
	)

Wrapper for the FMI function fmiGetStringStatus(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
s	Kind of status to return the value for.
value	(Output) FMI string value.

Returns: FMI status.

Functions

Detailed Description

Function Documentation