Class Globals

Provides all possible I/O options
Inheritance
System.Object
Globals
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Mars.Interfaces.Model
Assembly: Mars.Interfaces.dll
Syntax
public class Globals

Constructors

| Improve this Doc View Source

Globals()

Creates an empty global inputConfiguration object which keeps information about any connection and formatting settings.
Declaration
public Globals()

Properties

| Improve this Doc View Source

AscOptions

Gets or sets the options container for the 'asc' output of raster-layers
Declaration
[JsonProperty("ascOptions", NullValueHandling = NullValueHandling.Ignore)]
public AscOptions AscOptions { get; set; }
Property Value
Type Description
AscOptions
| Improve this Doc View Source

CsvOptions

Gets or sets the output options, specifying everything around the selected OutputTarget.Csv
Declaration
[JsonProperty("csvOptions", NullValueHandling = NullValueHandling.Ignore)]
public CsvOptions CsvOptions { get; set; }
Property Value
Type Description
CsvOptions
| Improve this Doc View Source

DeltaT

The size of one step to continue the simulation execution
Declaration
[JsonProperty("deltaT", NullValueHandling = NullValueHandling.Ignore)]
public int DeltaT { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DeltaTTimeSpan

The timespan calculated from the DeltaT and DeltaTUnit
Declaration
[JsonIgnore]
public TimeSpan? DeltaTTimeSpan { get; }
Property Value
Type Description
System.Nullable<System.TimeSpan>
| Improve this Doc View Source

DeltaTTimeSpanSingle

The 1 unit of the realtime calculated from the DeltaT=1 and DeltaTUnit
Declaration
[JsonIgnore]
public TimeSpan? DeltaTTimeSpanSingle { get; }
Property Value
Type Description
System.Nullable<System.TimeSpan>
| Improve this Doc View Source

DeltaTUnit

The timespan unit for real-time reference
Declaration
[JsonProperty("deltaTUnit", NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(TimeSpanUnitConverter))]
public TimeSpanUnit DeltaTUnit { get; set; }
Property Value
Type Description
TimeSpanUnit
| Improve this Doc View Source

EndPoint

The System.DateTime end point for real-time simulation
Declaration
[JsonProperty("endPoint", NullValueHandling = NullValueHandling.Ignore)]
public DateTime? EndPoint { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

GeoJsonOptions

Gets or sets the input/output options, specifying everything around processing of GeoJson files.
Declaration
[JsonProperty("geoJsonOptions", NullValueHandling = NullValueHandling.Ignore)]
public GeoJsonOptions GeoJsonOptions { get; set; }
Property Value
Type Description
GeoJsonOptions
| Improve this Doc View Source

InputOutputOptions

Gets or sets the input output options for connected services.
Declaration
[JsonIgnore]
public AbstractOptions InputOutputOptions { get; }
Property Value
Type Description
AbstractOptions
| Improve this Doc View Source

IsRealtimeRelated

Indicates whether this sim config has real-time reference
Declaration
[JsonIgnore]
public bool IsRealtimeRelated { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LiveVisualization

Provides all possible I/O options
Declaration
[JsonProperty("pythonVisualization", NullValueHandling = NullValueHandling.Ignore)]
public bool LiveVisualization { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MongoOptions

Gets or sets the output options, specifying everything around the selected OutputTarget.DocumentStore
Declaration
[JsonProperty("mongoOptions", NullValueHandling = NullValueHandling.Ignore)]
public MongoOptions MongoOptions { get; set; }
Property Value
Type Description
MongoOptions
| Improve this Doc View Source

OptionSet

Gets all available and assigned options of this simulation inputConfiguration.
Declaration
[JsonIgnore]
public IEnumerable<AbstractOptions> OptionSet { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<AbstractOptions>
| Improve this Doc View Source

OutputTarget

Gets or sets the output target used globally for all entities. This output target specifies the concrete format of generated results of the simulation execution.
Declaration
[JsonProperty("output", NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(OutputTargetConverter))]
public OutputTargetType OutputTarget { get; set; }
Property Value
Type Description
OutputTargetType
Remarks
The output target specifies the concrete format of generated results of the simulation execution (e.g., table as csv or documents in mongo).
| Improve this Doc View Source

PostgresSqlOptions

Gets or sets the output options, specifying everything around the selected PostgresSql for the OutputTarget
Declaration
[JsonProperty("npgSqlOptions", NullValueHandling = NullValueHandling.Ignore)]
public PostgresSqlOptions PostgresSqlOptions { get; set; }
Property Value
Type Description
PostgresSqlOptions
| Improve this Doc View Source

RedisOptions

Gets or sets the options for the redis key-value mapper
Declaration
[JsonProperty("redisOptions", NullValueHandling = NullValueHandling.Ignore)]
public RedisOptions RedisOptions { get; set; }
Property Value
Type Description
RedisOptions
| Improve this Doc View Source

ReportProgress

Gets or sets the flag whether to activate progress report over websocket.
Declaration
[JsonProperty("reportProgress", NullValueHandling = NullValueHandling.Ignore)]
public bool ReportProgress { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ShowConsoleProgress

Gets or sets the flag to show the progress of the execution on the console. Default is false to prevent IO problems during test execution.
Declaration
[JsonProperty("console", NullValueHandling = NullValueHandling.Ignore)]
public bool ShowConsoleProgress { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

SocketOutputOptions

Gets or sets the output options, specifying everything around the selected OutputTarget.GeoJsonSocket, OutputTarget.Socket
Declaration
[JsonProperty("socketOptions", NullValueHandling = NullValueHandling.Ignore)]
public SocketOutputOptions SocketOutputOptions { get; set; }
Property Value
Type Description
SocketOutputOptions
| Improve this Doc View Source

SpatialGraphOptions

Gets or sets the option set used to create the ISpatialGraphEnvironment.
Declaration
[JsonProperty("sgeOptions", NullValueHandling = NullValueHandling.Ignore)]
public SpatialGraphOptions SpatialGraphOptions { get; set; }
Property Value
Type Description
SpatialGraphOptions
| Improve this Doc View Source

Speed

Gets or sets the speed in percentage 0-100% setting the simulation speed to maximum (100%) or stop the run (0%).
Declaration
[JsonProperty("tickSpeed")]
public double? Speed { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
| Improve this Doc View Source

SqLiteOptions

Gets or sets the output options, specifying everything around the selected SqLite for the OutputTarget
Declaration
[JsonProperty("sqLiteOptions", NullValueHandling = NullValueHandling.Ignore)]
public SqLiteOptions SqLiteOptions { get; set; }
Property Value
Type Description
SqLiteOptions
| Improve this Doc View Source

StartPoint

The System.DateTime start point for real-time simulation
Declaration
[JsonProperty("startPoint", NullValueHandling = NullValueHandling.Ignore)]
public DateTime? StartPoint { get; set; }
Property Value
Type Description
System.Nullable<System.DateTime>
| Improve this Doc View Source

StartStep

Gets or sets the starting tick
Declaration
[JsonProperty("startTick", NullValueHandling = NullValueHandling.Ignore)]
public int? StartStep { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
| Improve this Doc View Source

Steps

The full amount of steps to simulate
Declaration
[JsonProperty("steps", NullValueHandling = NullValueHandling.Ignore)]
public long? Steps { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>
| Improve this Doc View Source

Ticks

The alternative description for Steps
Declaration
[JsonProperty("ticks", NullValueHandling = NullValueHandling.Ignore)]
public long? Ticks { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>
| Improve this Doc View Source

TripsOptions

Gets or sets the options used when serializing trajectories of entities.
Declaration
[JsonProperty("tripsOptions", NullValueHandling = NullValueHandling.Ignore)]
public TripsOptions TripsOptions { get; set; }
Property Value
Type Description
TripsOptions

Extension Methods