Interface ISimulationState

Namespace: Mars.Interfaces
Assembly: Mars.Interfaces.dll
Syntax
public interface ISimulationState

Properties

| Improve this Doc View Source

CurrentStep

Currently logical simulation step that is used
Declaration
[JsonProperty(PropertyName = "currentStep")]
long CurrentStep { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

CurrentTick

Currently simulation system tick of the workflow
Declaration
[JsonProperty(PropertyName = "currentTick")]
long CurrentTick { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

CurrentTimePoint

Realtime time point of the currently executed step
Declaration
[JsonProperty(PropertyName = "currentDateTime", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
DateTime? CurrentTimePoint { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

IsAborted

Indicates whether the simulation was aborted
Declaration
[JsonProperty("isAborted")]
bool IsAborted { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsFinished

Indicates whether the simulation run is finished
Declaration
[JsonProperty("isFinished")]
bool IsFinished { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsInitialized

Indicates whether the simulation run was prepared for the first step
Declaration
[JsonProperty("isInitialized")]
bool IsInitialized { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsPaused

Indicates whether the simulation was paused
Declaration
[JsonProperty("isPaused")]
bool IsPaused { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Iterations

The count of successful executed steps
Declaration
[JsonProperty(PropertyName = "iterations", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
long Iterations { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

LastDateTime

The last successfully executed model time point
Declaration
[JsonProperty("lastSuccessfullyDateTime", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
DateTime? LastDateTime { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

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
[JsonProperty("lastPauseDateTime", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
DateTime? LastPauseDateTime { get; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

LastPauseStep

The real simulation step where the pause command was received or null if no pause was ever received
Declaration
[JsonProperty("lastPauseStep", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
long? LastPauseStep { get; }
Property Value
Type Description
System.Nullable<System.Int64>
| Improve this Doc View Source

LastPauseTick

The simulation system tick where the pause command was received or null if no pause was ever received
Declaration
[JsonProperty("lastPauseTick", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
long? LastPauseTick { get; }
Property Value
Type Description
System.Nullable<System.Int64>
| Improve this Doc View Source

LastStep

The successfully executed model step or null if no step was executed
Declaration
[JsonProperty("lastSuccessfullyStep", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
long? LastStep { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>
| Improve this Doc View Source

LastTick

The successfully executed system tick beginning at 0 or null if no system tick was executed
Declaration
[JsonProperty("lastSuccessfullyTick", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
long? LastTick { get; }
Property Value
Type Description
System.Nullable<System.Int64>
| Improve this Doc View Source

ProgressInPercentage

Gets the current percentage progress of the simulation execution comparing CurrentTick with MaxTicks.
Declaration
[JsonProperty("progressInPercentage")]
double ProgressInPercentage { get; }
Property Value
Type Description
System.Double

Extension Methods