Instance Class |
Fmu instance.
Inheritance HierarchyNamespace: Emulate3D.FMI.V2
Assembly: Emulate3D.FMI (in Emulate3D.FMI.dll) Version: 19.00.00
SyntaxC#
public sealed class Instance : IInstance, IDisposable, INotifyPropertyChanged, ICoSimulator
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. |
| Fmu | Fmu that created this instance. |
| Name | Instance name. |
| NameToVariable | Read-only mapping between Name and the variable. |
| Platform | Instance platform. |
| PreferredStep | The preferred communication step size in milliseconds. |
| Variables | Read-only list of all variables. |
Methods| Name | Description | |
|---|---|---|
 | CancelStep | Cancel a time step. Can be called if DoStep(Double, Double, Boolean) returned Pending in order to stop the current asynchronous execution. |
| DeserializeFmuState | Deserializes the byte vector, constructs a copy of the instance state and returns the pointer to this copy. |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| DoStep | Compute a time step. |
| EnterInitializationMode | Informs the instance to enter initialization mode. |
| ExitInitializationMode | Informs the instance to exit initialization mode. |
| FreeFmuState | Frees all memory and other resources allocated with the GetFmuState(IntPtr) call for this FMU state. |
| FreeInstance | 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 instance interface. |
| GetBoolean | Update values of boolean variables. Calls the respective API function call. |
| GetBooleanStatus | Informs about the actual status of the simulation run. |
| GetDirectionalDerivative | Compute the directional derivatives of the instance. |
| GetFmuState | Makes a copy of the internal FMU state and assigns a pointer to this copy. |
| GetInteger | Update values of integer variables. Calls the respective API function call. |
| GetIntegerStatus | Informs about the actual status of the simulation run. |
| GetReal | Update values of real variables. Calls the respective API function call. |
| GetRealInputDerivatives | Gets the n-th time derivative of real input variables. |
| GetRealStatus | Informs about the actual status of the simulation run. |
| GetSerializedFmuStateSize | Get the size of the byte vector, in order that FMU state can be stored in it. |
| GetStatus | Informs about the actual status of the simulation run. |
| GetString | Update values of string variables. Calls the respective API function call. |
| GetStringStatus | Informs about the actual status of the simulation run. |
| Reset | Reset the instance after a simulation run. |
| SerializeFmuState | Serializes the data which is referenced by pointer and copies this data in to the byte vector. |
| SetBoolean | Write current values of boolean variables. Calls the respective API function call. |
| SetDebugLogging | Controls the debug logging that is output via the logger callback function by the instance. |
| SetFmuState | Copy the content of the previously copied FMU state back and use it as new FMU state. the instance state copy still exists. |
| SetInteger | Write current values of integer variables. Calls the respective API function call. |
| SetReal | Write current values of real variables. Calls the respective API function call. |
| SetRealInputDerivatives | Sets the n-th time derivative of real input variables. |
| SetString | Write current values of string variables. Calls the respective API function call. |
| SetupExperiment | Informs the instance to setup the experiment. |
| Terminate | Informs the instance that the simulation run is terminated. |
Events| Name | Description | |
|---|---|---|
 | OnEnterInitializationMode | Raised when the instance has entered initialization mode. |
| OnExitInitializationMode | Raised when the instance has exited initialization mode. |
| OnLogMessage | Raised when the instance calls the log message callback function. |
| OnStepFinished | Raised when the instance calls the step finished callback function. |
| PropertyChanged | Occurs when a property value changes. |
See Also