FMI 2.0 (ME) Model Exchange functions

List of Model Exchange wrapper functions. Common functions are not listed. More...

Functions
FMILIB_EXPORT fmi2_status_t	fmi2_import_enter_event_mode (fmi2_import_t *fmu)
	Calls the FMI function fmiEnterEventMode(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_new_discrete_states (fmi2_import_t *fmu, fmi2_event_info_t *eventInfo)
	Calls the FMI function fmiNewDiscreteStates(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_enter_continuous_time_mode (fmi2_import_t *fmu)
	Calls the FMI function fmiEnterContinuousTimeMode(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_set_time (fmi2_import_t *fmu, fmi2_real_t time)
	Wrapper for the FMI function fmiSetTime(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_set_continuous_states (fmi2_import_t *fmu, const fmi2_real_t x[], size_t nx)
	Wrapper for the FMI function fmiSetContinuousStates(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_completed_integrator_step (fmi2_import_t *fmu, fmi2_boolean_t noSetFMUStatePriorToCurrentPoint, fmi2_boolean_t *enterEventMode, fmi2_boolean_t *terminateSimulation)
	Wrapper for the FMI function fmiCompletedIntegratorStep(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_get_derivatives (fmi2_import_t *fmu, fmi2_real_t derivatives[], size_t nx)
	Wrapper for the FMI function fmiGetDerivatives(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_get_event_indicators (fmi2_import_t *fmu, fmi2_real_t eventIndicators[], size_t ni)
	Wrapper for the FMI function fmiGetEventIndicators(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_get_continuous_states (fmi2_import_t *fmu, fmi2_real_t states[], size_t nx)
	Wrapper for the FMI function fmiGetContinuousStates(...) More...
FMILIB_EXPORT fmi2_status_t	fmi2_import_get_nominals_of_continuous_states (fmi2_import_t *fmu, fmi2_real_t x_nominal[], size_t nx)
	Wrapper for the FMI function fmiGetNominalsOfContinuousStates(...) More...

Detailed Description

List of Model Exchange wrapper functions. Common functions are not listed.

Function Documentation

FMILIB_EXPORT fmi2_status_t fmi2_import_enter_event_mode

(

fmi2_import_t *

fmu

)

Calls the FMI function fmiEnterEventMode(...)

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_new_discrete_states	(	fmi2_import_t *	fmu,
		fmi2_event_info_t *	eventInfo
	)

Calls the FMI function fmiNewDiscreteStates(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
eventInfo	Pointer to fmi2_event_info_t structure that will be filled in.

Returns

FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_enter_continuous_time_mode

(

fmi2_import_t *

fmu

)

Calls the FMI function fmiEnterContinuousTimeMode(...)

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_set_time	(	fmi2_import_t *	fmu,
		fmi2_real_t	time
	)

Wrapper for the FMI function fmiSetTime(...)

Parameters

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

Returns

FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_set_continuous_states	(	fmi2_import_t *	fmu,
		const fmi2_real_t	x[],
		size_t	nx
	)

Wrapper for the FMI function fmiSetContinuousStates(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
x	Array of state values.
nx	Number of states.

Returns

FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_completed_integrator_step	(	fmi2_import_t *	fmu,
		fmi2_boolean_t	noSetFMUStatePriorToCurrentPoint,
		fmi2_boolean_t *	enterEventMode,
		fmi2_boolean_t *	terminateSimulation
	)

Wrapper for the FMI function fmiCompletedIntegratorStep(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
noSetFMUStatePriorToCurrentPoint	True if fmiSetFMUState will no longer be called for time instants prior to current time in this simulation run.
enterEventMode	(Output) Call fmiEnterEventMode indicator.
terminateSimulation	(Output) Terminate simulation indicator.

Returns

FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_derivatives	(	fmi2_import_t *	fmu,
		fmi2_real_t	derivatives[],
		size_t	nx
	)

Wrapper for the FMI function fmiGetDerivatives(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
derivatives	(Output) Array of the derivatives.
nx	Number of derivatives.

Returns

FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_event_indicators	(	fmi2_import_t *	fmu,
		fmi2_real_t	eventIndicators[],
		size_t	ni
	)

Wrapper for the FMI function fmiGetEventIndicators(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
eventIndicators	(Output) The event indicators.
ni	Number of event indicators.

Returns

FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_continuous_states	(	fmi2_import_t *	fmu,
		fmi2_real_t	states[],
		size_t	nx
	)

Wrapper for the FMI function fmiGetContinuousStates(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
states	(Output) Array of state values.
nx	Number of states.

Returns

FMI status.

FMILIB_EXPORT fmi2_status_t fmi2_import_get_nominals_of_continuous_states	(	fmi2_import_t *	fmu,
		fmi2_real_t	x_nominal[],
		size_t	nx
	)

Wrapper for the FMI function fmiGetNominalsOfContinuousStates(...)

Parameters

fmu	A model description object returned by fmi2_import_parse_xml() that has loaded the FMI functions, see fmi2_import_create_dllfmu().
x_nominal	(Output) The nominal values.
nx	Number of nominal values.

Returns

FMI status.