Click or drag to resize

Instance Class

Fmu instance.
Inheritance Hierarchy
SystemObject
  Emulate3D.FMI.V2Instance

Namespace:  Emulate3D.FMI.V2
Assembly:  Emulate3D.FMI (in Emulate3D.FMI.dll) Version: 18.04.00
Syntax
C#
public sealed class Instance : IInstance, 
	IDisposable, INotifyPropertyChanged

The Instance type exposes the following members.

Properties
  NameDescription
Public propertyCurrentStep
The current communication step size in milliseconds. Updated after the step size has been calculated, but before the step is executed. -1 indicates no current step size.
Public propertyDiscardAction
The action to take when an API method returns a Discard status. These action is only taken when the API is called by the simulation, not as a result of scripting.
Public propertyErrorAction
The action to take when an API method returns an Error status. These action is only taken when the API is called by the simulation, not as a result of scripting.
Public propertyFatalAction
The action to take when an API method returns a Fatal status. These action is only taken when the API is called by the simulation, not as a result of scripting.
Public propertyFmu
Fmu that created this instance.
Public propertyIndividualIO
If true, IO functions are called for each variable individually.
Public propertyMaxStep
The minimum communication step size in milliseconds.
Public propertyMinStep
The minimum communication step size in milliseconds.
Public propertyName
Instance name.
Public propertyNameToVariable
Read-only mapping between Name and the variable.
Public propertyOKAction
The action to take when an API method returns an OK status. These action is only taken when the API is called by the simulation, not as a result of scripting.
Public propertyPlatform
Instance platform.
Public propertyPreferredStep
The preferred communication step size in milliseconds. -1 indicates no preferred step size.
Public propertyStopTimeAction
Defines what action to take when the simulation reaches a pre-defined stop-time.
Public propertyVariables
Read-only list of all variables.
Public propertyWarningAction
The action to take when an API method returns a Warning status. These action is only taken when the API is called by the simulation, not as a result of scripting.
Top
Methods
  NameDescription
Public methodCancelStep
Cancel a time step. Can be called if DoStep(Double, Double, Boolean) returned Pending in order to stop the current asynchronous execution.
Public methodDeserializeFmuState
Deserializes the byte vector, constructs a copy of the FMU state and returns the pointer to this copy.
Public methodDispose
Releases all resources used by the Instance
Public methodDoStep
Compute a time step.
Public methodEnterInitializationMode
Informs the FMU to enter initialization mode.
Public methodExitInitializationMode
Informs the FMU to exit initialization mode.
Public methodFreeFmuState
Frees all memory and other resources allocated with the GetFmuState(IntPtr) call for this FMU state.
Public methodFreeInstance
Disposes the instance, unloads the loaded model, and frees all the allocated memory and other resources that have been allocated by the functions of the FMU interface.
Public methodGetBoolean
Update values of boolean variables. Calls the respective API function call.
Public methodGetBooleanStatus
Informs about the actual status of the simulation run.
Public methodGetDirectionalDerivative
Compute the directional derivatives of the FMU.
Public methodGetFmuState
Makes a copy of the internal FMU state and assigns a pointer to this copy.
Public methodGetInteger
Update values of integer variables. Calls the respective API function call.
Public methodGetIntegerStatus
Informs about the actual status of the simulation run.
Public methodGetReal
Update values of real variables. Calls the respective API function call.
Public methodGetRealInputDerivatives
Gets the n-th time derivative of real input variables.
Public methodGetRealStatus
Informs about the actual status of the simulation run.
Public methodGetSerializedFmuStateSize
Get the size of the byte vector, in order that FMU state can be stored in it.
Public methodGetStatus
Informs about the actual status of the simulation run.
Public methodGetString
Update values of string variables. Calls the respective API function call.
Public methodGetStringStatus
Informs about the actual status of the simulation run.
Public methodReset
Reset the FMU after a simulation run.
Public methodSerializeFmuState
Serializes the data which is referenced by pointer and copies this data in to the byte vector.
Public methodSetBoolean
Write current values of boolean variables. Calls the respective API function call.
Public methodSetDebugLogging
Controls the debug logging that is output via the logger callback function by the FMU.
Public methodSetFmuState
Copy the content of the previously copied FMU state back and use it as new FMU state. The FMU state copy still exists.
Public methodSetInteger
Write current values of integer variables. Calls the respective API function call.
Public methodSetReal
Write current values of real variables. Calls the respective API function call.
Public methodSetRealInputDerivatives
Sets the n-th time derivative of real input variables.
Public methodSetString
Write current values of string variables. Calls the respective API function call.
Public methodSetupExperiment
Informs the FMU to setup the experiment.
Public methodTerminate
Informs the FMU that the simulation run is terminated.
Top
Events
  NameDescription
Public eventOnEnterInitializationMode
Raised when the FMU has entered initialization mode.
Public eventOnExitInitializationMode
Raised when the FMU has exited initialization mode.
Public eventOnLogMessage
Raised when the FMU calls the log message callback function.
Public eventOnStepFinished
Raised when the FMU calls the step finished callback function.
Public eventPropertyChanged
Top
See Also