Interface ISimulationControl
Inherited Members
System.IDisposable.Dispose()
Namespace: Mars.Core.Simulation
Assembly: Mars.Core.dll
Syntax
public interface ISimulationControl : IDisposableMethods
| Improve this Doc View SourceAbortSimulation()
Abort the current simulation lifecycle and returns
the last state lifecycle state which is now aborted.
Declaration
SimulationWorkflowState AbortSimulation()Returns
| Type | Description |
|---|---|
| SimulationWorkflowState | The actual executed SimulationWorkflowState which is aborted. |
PauseSimulation()
Pause the simulation lifecycle and returns the
last lifecycle state which is now paused.
Declaration
SimulationWorkflowState PauseSimulation()Returns
| Type | Description |
|---|---|
| SimulationWorkflowState | The actual executed SimulationWorkflowState which is paused. |
ResumeSimulation()
Continue a paused simulation lifecycle as a synchronous
operation and waits until it the simulation ends.
Declaration
SimulationWorkflowState ResumeSimulation()Returns
| Type | Description |
|---|---|
| SimulationWorkflowState | The SimulationWorkflowState of the finished simulation. |
StepSimulation()
Executes exactly one application tick for all registered
entities
and layers and creates result.
Declaration
SimulationWorkflowState StepSimulation()Returns
| Type | Description |
|---|---|
| SimulationWorkflowState | Returns the next SimulationWorkflowState which was executed. |