Instance Class |
Namespace: Emulate3D.FMI.V2
public sealed class Instance : IInstance, IDisposable, INotifyPropertyChanged
The Instance type exposes the following members.
| 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.
|
| 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 FMU state and returns the pointer to this copy.
| |
| Dispose | Releases all resources used by the Instance | |
| DoStep |
Compute a time step.
| |
| EnterInitializationMode |
Informs the FMU to enter initialization mode.
| |
| ExitInitializationMode |
Informs the FMU 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 FMU 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 FMU.
| |
| 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 FMU 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 FMU.
| |
| SetFmuState |
Copy the content of the previously copied FMU state back and use it as new FMU state.
The FMU 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 FMU to setup the experiment.
| |
| Terminate |
Informs the FMU that the simulation run is terminated.
|
| Name | Description | |
|---|---|---|
| OnEnterInitializationMode |
Raised when the FMU has entered initialization mode.
| |
| OnExitInitializationMode |
Raised when the FMU has exited initialization mode.
| |
| OnLogMessage |
Raised when the FMU calls the log message callback function.
| |
| OnStepFinished |
Raised when the FMU calls the step finished callback function.
| |
| PropertyChanged |