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

Functions
FMILIB_EXPORT const char *	fmi1_import_get_types_platform (fmi1_import_t *fmu)
	Wrapper for the FMI function fmiGetTypesPlatform(...) More...

FMILIB_EXPORT jm_status_enu_t	fmi1_import_instantiate_slave (fmi1_import_t *fmu, fmi1_string_t instanceName, fmi1_string_t fmuLocation, fmi1_string_t mimeType, fmi1_real_t timeout, fmi1_boolean_t visible, fmi1_boolean_t interactive)
	Wrapper for the FMI function fmiInstantiateSlave(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_initialize_slave (fmi1_import_t *fmu, fmi1_real_t tStart, fmi1_boolean_t StopTimeDefined, fmi1_real_t tStop)
	Wrapper for the FMI function fmiInitializeSlave(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_terminate_slave (fmi1_import_t *fmu)
	Wrapper for the FMI function fmiTerminateSlave(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_reset_slave (fmi1_import_t *fmu)
	Wrapper for the FMI function fmiResetSlave(...) More...

FMILIB_EXPORT void	fmi1_import_free_slave_instance (fmi1_import_t *fmu)
	Wrapper for the FMI function fmiFreeSlaveInstance(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_set_real_input_derivatives (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], const fmi1_real_t value[])
	Wrapper for the FMI function fmiSetRealInputDerivatives(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_get_real_output_derivatives (fmi1_import_t *fmu, const fmi1_value_reference_t vr[], size_t nvr, const fmi1_integer_t order[], fmi1_real_t value[])
	Wrapper for the FMI function fmiGetOutputDerivatives(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_cancel_step (fmi1_import_t *fmu)
	Wrapper for the FMI function fmiCancelStep(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_do_step (fmi1_import_t *fmu, fmi1_real_t currentCommunicationPoint, fmi1_real_t communicationStepSize, fmi1_boolean_t newStep)
	Wrapper for the FMI function fmiDoStep(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_get_status (fmi1_import_t fmu, const fmi1_status_kind_t s, fmi1_status_t value)
	Wrapper for the FMI function fmiGetStatus(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_get_real_status (fmi1_import_t fmu, const fmi1_status_kind_t s, fmi1_real_t value)
	Wrapper for the FMI function fmiGetRealStatus(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_get_integer_status (fmi1_import_t fmu, const fmi1_status_kind_t s, fmi1_integer_t value)
	Wrapper for the FMI function fmiGetIntegerStatus(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_get_boolean_status (fmi1_import_t fmu, const fmi1_status_kind_t s, fmi1_boolean_t value)
	Wrapper for the FMI function fmiGetBooleanStatus(...) More...

FMILIB_EXPORT fmi1_status_t	fmi1_import_get_string_status (fmi1_import_t fmu, const fmi1_status_kind_t s, fmi1_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 const char* fmi1_import_get_types_platform ( fmi1_import_t * fmu )

Wrapper for the FMI function fmiGetTypesPlatform(...)

Parameters

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

Returns: The platform the FMU was compiled for.

FMILIB_EXPORT jm_status_enu_t fmi1_import_instantiate_slave	(	fmi1_import_t *	fmu,
		fmi1_string_t	instanceName,
		fmi1_string_t	fmuLocation,
		fmi1_string_t	mimeType,
		fmi1_real_t	timeout,
		fmi1_boolean_t	visible,
		fmi1_boolean_t	interactive
	)

Wrapper for the FMI function fmiInstantiateSlave(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
instanceName	The name of the instance.
fmuLocation	Access path to the FMU archive. If null FMU will get the path to the directory where it was unpacked.
mimeType	MIME type. If NULL the FMU will get "application/x-fmu-sharedlibrary".
timeout	Communication timeout value in milli-seconds.
visible	Indicates whether or not the simulator application window shoule be visible.
interactive	Indicates whether the simulator application must be manually started by the user.

Returns: Error status. Returnes jm_status_error if fmiInstantiateSlave returned NULL, otherwise jm_status_success.

FMILIB_EXPORT fmi1_status_t fmi1_import_initialize_slave	(	fmi1_import_t *	fmu,
		fmi1_real_t	tStart,
		fmi1_boolean_t	StopTimeDefined,
		fmi1_real_t	tStop
	)

Wrapper for the FMI function fmiInitializeSlave(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_import_create_dllfmu().
tStart	Start time of the simulation
StopTimeDefined	Indicates whether or not the stop time is used.
tStop	The stop time of the simulation.

Returns: FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_terminate_slave ( fmi1_import_t * fmu )

Wrapper for the FMI function fmiTerminateSlave(...)

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 status.

FMILIB_EXPORT fmi1_status_t fmi1_import_reset_slave ( fmi1_import_t * fmu )

Wrapper for the FMI function fmiResetSlave(...)

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 status.

FMILIB_EXPORT void fmi1_import_free_slave_instance ( fmi1_import_t * fmu )

Wrapper for the FMI function fmiFreeSlaveInstance(...)

Parameters

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

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

Wrapper for the FMI function fmiSetRealInputDerivatives(...)

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.
order	Array of derivative orders.
value	Array of variable values.

Returns: FMI status.

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

Wrapper for the FMI function fmiGetOutputDerivatives(...)

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.
order	Array of derivative orders.
value	(Output) Array of variable values.

Returns: FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_cancel_step ( fmi1_import_t * fmu )

Wrapper for the FMI function fmiCancelStep(...)

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 status.

FMILIB_EXPORT fmi1_status_t fmi1_import_do_step	(	fmi1_import_t *	fmu,
		fmi1_real_t	currentCommunicationPoint,
		fmi1_real_t	communicationStepSize,
		fmi1_boolean_t	newStep
	)

Wrapper for the FMI function fmiDoStep(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_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 fmi1_status_t fmi1_import_get_status	(	fmi1_import_t *	fmu,
		const fmi1_status_kind_t	s,
		fmi1_status_t *	value
	)

Wrapper for the FMI function fmiGetStatus(...)

Parameters

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

Returns: FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_real_status	(	fmi1_import_t *	fmu,
		const fmi1_status_kind_t	s,
		fmi1_real_t *	value
	)

Wrapper for the FMI function fmiGetRealStatus(...)

Parameters

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

Returns: FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_integer_status	(	fmi1_import_t *	fmu,
		const fmi1_status_kind_t	s,
		fmi1_integer_t *	value
	)

Wrapper for the FMI function fmiGetIntegerStatus(...)

Parameters

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

Returns: FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_boolean_status	(	fmi1_import_t *	fmu,
		const fmi1_status_kind_t	s,
		fmi1_boolean_t *	value
	)

Wrapper for the FMI function fmiGetBooleanStatus(...)

Parameters

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

Returns: FMI status.

FMILIB_EXPORT fmi1_status_t fmi1_import_get_string_status	(	fmi1_import_t *	fmu,
		const fmi1_status_kind_t	s,
		fmi1_string_t *	value
	)

Wrapper for the FMI function fmiGetStringStatus(...)

Parameters

fmu	A model description object returned by fmi1_import_parse_xml() that has loaded the FMI functions, see fmi1_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