Interface ISimulationState
Namespace: Mars.Interfaces
Assembly: Mars.Interfaces.dll
Syntax
public interface ISimulationStateProperties
CurrentStep
Currently logical simulation step that is used
Declaration
long CurrentStep { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
CurrentTick
Currently simulation system tick of the workflow
Declaration
long CurrentTick { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
CurrentTimePoint
Realtime time point of the currently executed step
Declaration
DateTime? CurrentTimePoint { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<DateTime> |
IsAborted
Indicates whether the simulation was aborted
Declaration
bool IsAborted { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsFinished
Indicates whether the simulation run is finished
Declaration
bool IsFinished { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsInitialized
Indicates whether the simulation run was prepared for the first step
Declaration
bool IsInitialized { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsPaused
Indicates whether the simulation was paused
Declaration
bool IsPaused { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Iterations
The count of successful executed steps
Declaration
long Iterations { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
LastAbortDateTime
The model time point where an abortion of the simulation lifecycle was received
Declaration
DateTime? LastAbortDateTime { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<DateTime> |
LastAbortStep
The model step where an abortion of the simulation lifecycle was received
Declaration
long? LastAbortStep { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
LastAbortTick
The simulation system tick where an abortion of the simulation lifecycle was received
Declaration
long? LastAbortTick { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
LastDateTime
The last successfully executed model time point
Declaration
DateTime? LastDateTime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<DateTime> |
LastPauseDateTime
The time point for realtime execution where the a pause of the loop was received
or null if no pause was ever received
Declaration
DateTime? LastPauseDateTime { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<DateTime> |
LastPauseStep
The real simulation step where the pause command was received
or null if no pause was ever received
Declaration
long? LastPauseStep { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
LastPauseTick
The simulation system tick where the pause command was received
or null if no pause was ever received
Declaration
long? LastPauseTick { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
LastStep
The successfully executed model step
or null if no step was executed
Declaration
long? LastStep { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
LastTick
The successfully executed system tick beginning at 0
or null if no system tick was executed
Declaration
long? LastTick { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
ProgressInPercentage
Gets the current percentage progress of the simulation execution comparing CurrentTick with
MaxTicks.
Declaration
double ProgressInPercentage { get; }Property Value
| Type | Description |
|---|---|
| System.Double |