Interface ISimulationContext

Inherited Members
System.IDisposable.Dispose()
Namespace: Mars.Interfaces
Assembly: Mars.Interfaces.dll
Syntax
public interface ISimulationContext : ISimulationState, IDisposable

Properties

| Improve this Doc View Source

Active

Indicates the active or inactive state of the simulation workflow loop
Declaration
[JsonIgnore]
bool Active { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

EndTimePoint

Gets the ending realtime for the last executed simulation tick.
Declaration
[JsonProperty("endTimePoint", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
DateTime? EndTimePoint { get; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

InputWatch

Gets the stopwatch, used to measure the duration of the initialization phase, for each agent, entity and layer together.
Declaration
[JsonIgnore]
Stopwatch InputWatch { get; }
Property Value
Type Description
System.Diagnostics.Stopwatch
| Improve this Doc View Source

IsTimeReferenced

Determines whether the simulation is executed with a reference to time or not
Declaration
[JsonProperty("isTimeReferenced", DefaultValueHandling = DefaultValueHandling.Ignore)]
bool IsTimeReferenced { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MaxTicks

Gets or sets the maximum amount of ticks, when a simulation time-range is specified.
Declaration
[JsonProperty("maxTicks")]
long MaxTicks { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

OneTickTimeSpan

Gets the global accessible time delta interval for realtime scenarios.
Declaration
[JsonProperty("oneTickTimeSpan", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
TimeSpan? OneTickTimeSpan { get; }
Property Value
Type Description
System.Nullable<System.TimeSpan>
| Improve this Doc View Source

OutputWatch

Gets the tick watch, used to perform tick-wise measure during the execution.
Declaration
[JsonIgnore]
Stopwatch OutputWatch { get; }
Property Value
Type Description
System.Diagnostics.Stopwatch
| Improve this Doc View Source

RestartFlag

Indicates a restart of the simulation workflow, the workflow itself is active furthermore
Declaration
[JsonIgnore]
bool RestartFlag { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ResumeFlag

Indicates that the simulation shall be resumed from the last paused simulation step
Declaration
[JsonIgnore]
bool ResumeFlag { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

StartStep

Gets or sets the optional start step for step-based execution.
Declaration
[JsonIgnore]
long StartStep { get; set; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

StartTimePoint

Gets the initializing realtime for simulation tick 0.
Declaration
[JsonProperty("startTimePoint", DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
DateTime? StartTimePoint { get; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

StepFlag

Indicates whether a simulation step shall be calculated
Declaration
[JsonIgnore]
bool StepFlag { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

TickWatch

Gets the tick watch, used to perform tick-wise measure during the execution.
Declaration
[JsonIgnore]
Stopwatch TickWatch { get; }
Property Value
Type Description
System.Diagnostics.Stopwatch

Methods

| Improve this Doc View Source

SetTick(Int32, Int32)

Sets the current step context to the specified one.
Declaration
void SetTick(int tick, int delta = 1)
Parameters
Type Name Description
System.Int32 tick The ticks to set for.
System.Int32 delta The delta timespan of the logical time.
| Improve this Doc View Source

UpdateStep(Int32, Int32)

Updates the clock with the system execution tick by the specified amount of steps or 1 as default with step size deltaT and the current realtime point by OneTickTimeSpan by one simulation tick.
Declaration
void UpdateStep(int delta = 1, int steps = 1)
Parameters
Type Name Description
System.Int32 delta The logical delta step for move forward in time
System.Int32 steps The amount of steps to update for.

Extension Methods