Instance Class |
Fmu instance.
Inheritance HierarchySystemObject
Emulate3D.FMI.V3Instance
Emulate3D.FMI.V3Instance
Namespace: Emulate3D.FMI.V3
Assembly: Emulate3D.FMI (in Emulate3D.FMI.dll) Version: 18.04.00
SyntaxC#
public sealed class Instance : IInstance, IDisposable, INotifyPropertyChanged
The Instance type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CurrentStep |
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.
|
| DiscardAction |
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.
|
| ErrorAction |
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.
|
| FatalAction |
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.
|
| Fmu | Fmu that created this instance.
|
| IndividualIO |
If true, IO functions are called for each variable individually.
|
| MaxStep |
The minimum communication step size in milliseconds.
|
| MinStep |
The minimum communication step size in milliseconds.
|
| Name |
Instance name.
|
| NameToVariable |
Read-only mapping between Name and the variable.
|
| OKAction |
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.
|
| Platform |
Instance platform.
|
| PreferredStep |
The preferred communication step size in milliseconds.
-1 indicates no preferred step size.
|
| StopTimeAction |
Defines what action to take when the simulation reaches a pre-defined stop-time.
|
| Variables |
Read-only list of all variables.
|
| WarningAction |
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.
|
Methods| Name | Description | |
|---|---|---|
 | DeserializeFmuState |
Deserializes the byte vector, constructs a copy of the FMU state and returns the pointer to this copy.
|
| Dispose | Releases all resources used by the Instance |
| DoStep |
Requests the computation of the next time step.
|
| EnterConfigurationMode |
Enter configuration mode.
|
| EnterEventMode |
Enter event mode.
|
| EnterInitializationMode |
Enter initialization mode.
|
| ExitConfigurationMode |
Exit configuration mode.
|
| ExitInitializationMode |
Exit initialization mode.
|
| FreeFmuState |
This function frees all memory and other resources allocated with the GetFmuState(IntPtr) call for the provided pointer.
|
| FreeInstance |
Disposes the given 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.
|
| GetAdjointDerivative |
Get adjoint derivative.
|
| GetBinary |
Update values of binary variables.
Calls the respective API function call.
|
| GetBoolean |
Update values of boolean variables.
Calls the respective API function call.
|
| GetClock |
Update values of clock variables.
Calls the respective API function call.
|
| GetDirectionalDerivative |
Get directional derivative.
|
| GetFloat32 |
Update values of Float32 variables.
Calls the respective API function call.
|
| GetFloat64 |
Update values of Float64 variables.
Calls the respective API function call.
|
| GetFmuState |
This function copies the internal FMU state and returns a pointer to this copy.
|
| GetInt16 |
Update values of Int16 variables.
Calls the respective API function call.
|
| GetInt32 |
Update values of Int32 variables.
Calls the respective API function call.
|
| GetInt64 |
Update values of Int64 variables.
Calls the respective API function call.
|
| GetInt8 |
Update values of Int8 variables.
Calls the respective API function call.
|
| GetIntervalDecimal |
Get interval decimal for clock variables.
|
| GetIntervalFraction |
Get interval fraction for clock variables.
|
| GetNumberOfContinuousStates |
Get number of continuous states.
|
| GetNumberOfEventIndicators |
Get number of event indicators.
|
| GetNumberOfVariableDependencies |
Get the number of dependencies for a variable.
|
| GetOutputDerivatives |
Get output derivatives.
|
| GetSerializedFmuStateSize |
Returns the size of the byte vector, in order that the FMU state can be serialized in it.
|
| GetShiftDecimal |
Get shift decimal for clock variables.
|
| GetShiftFraction |
Get shift fraction for clock variables.
|
| GetString |
Update values of string variables.
Calls the respective API function call.
|
| GetUInt16 |
Update values of UInt16 variables.
Calls the respective API function call.
|
| GetUInt32 |
Update values of UInt32 variables.
Calls the respective API function call.
|
| GetUInt64 |
Update values of UInt64 variables.
Calls the respective API function call.
|
| GetUInt8 |
Update values of UInt8 variables.
Calls the respective API function call.
|
| GetVariableDependencies |
Get variable dependencies for a specific dependent variable.
|
| Reset |
Reset the FMU after a simulation run.
|
| SerializeFmuState |
Serializes the data which is referenced by the pointer and copies this data in to the byte vector.
|
| SetBinary |
Write current values of binary variables.
Calls the respective API function call.
|
| SetBoolean |
Write current values of boolean variables.
Calls the respective API function call.
|
| SetClock |
Write current values of clock variables.
Calls the respective API function call.
|
| SetDebugLogging |
Controls the debug logging that is output via the logger callback function by the FMU.
|
| SetFloat32 |
Write current values of Float32 variables.
Calls the respective API function call.
|
| SetFloat64 |
Write current values of Float64 variables.
Calls the respective API function call.
|
| SetFmuState |
This function restores the state provided by the pointer to FMU state.
|
| SetInt16 |
Write current values of Int16 variables.
Calls the respective API function call.
|
| SetInt32 |
Write current values of Int32 variables.
Calls the respective API function call.
|
| SetInt64 |
Write current values of Int64 variables.
Calls the respective API function call.
|
| SetInt8 |
Write current values of Int8 variables.
Calls the respective API function call.
|
| SetIntervalDecimal |
Set interval decimal for clock variables.
|
| SetIntervalFraction |
Set interval fraction for clock variables.
|
| SetShiftDecimal |
Set shift decimal for clock variables.
|
| SetShiftFraction |
Set shift fraction for clock variables.
|
| SetString |
Write current values of string variables.
Calls the respective API function call.
|
| SetUInt16 |
Write current values of UInt16 variables.
Calls the respective API function call.
|
| SetUInt32 |
Write current values of UInt32 variables.
Calls the respective API function call.
|
| SetUInt64 |
Write current values of UInt64 variables.
Calls the respective API function call.
|
| SetUInt8 |
Write current values of UInt8 variables.
Calls the respective API function call.
|
| Terminate |
Changes instance state to terminated.
|
Events| Name | Description | |
|---|---|---|
 | OnClockUpdate |
Raised when the FMU calls the clock update callback function.
|
| OnEnterConfigurationMode |
Raised when the FMU has entered configuration or reconfiguration mode.
|
| OnEnterInitializationMode |
Raised when the FMU has entered initialization mode.
|
| OnExitConfigurationMode |
Raised when the FMU has exited configuration or reconfiguration mode.
|
| OnExitInitializationMode |
Raised when the FMU has exited initialization mode.
|
| OnIntermediateUpdate |
Raised when the FMU calls the intermediate update callback function.
|
| OnLockPreemption |
Raised when the FMU calls the lock preemption callback function.
|
| OnLogMessage |
Raised when the FMU calls the log message callback function.
|
| OnUnlockPreemption |
Raised when the FMU calls the unlock preemption callback function.
|
| PropertyChanged |
See Also