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
Globals()
Creates an empty global inputConfiguration object which keeps information
about any connection and formatting settings.
Declaration
public Globals()
Properties
AscOptions
Gets or sets the options container for the 'asc' output of raster-layers
Declaration
public AscOptions AscOptions { get; set; }
Property Value
Type | Description |
---|---|
AscOptions |
CsvOptions
Gets or sets the output options, specifying everything around the selected
OutputTarget.Csv
Declaration
public CsvOptions CsvOptions { get; set; }
Property Value
Type | Description |
---|---|
CsvOptions |
DeltaT
The size of one step to continue the simulation execution
Declaration
public int DeltaT { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
DeltaTTimeSpan
The timespan calculated from the DeltaT and DeltaTUnit
Declaration
public TimeSpan? DeltaTTimeSpan { get; }
Property Value
Type | Description |
---|---|
System.Nullable<System.TimeSpan> |
DeltaTTimeSpanSingle
The 1 unit of the realtime calculated from the DeltaT=1 and DeltaTUnit
Declaration
public TimeSpan? DeltaTTimeSpanSingle { get; }
Property Value
Type | Description |
---|---|
System.Nullable<System.TimeSpan> |
DeltaTUnit
The timespan unit for real-time reference
Declaration
public TimeSpanUnit DeltaTUnit { get; set; }
Property Value
Type | Description |
---|---|
TimeSpanUnit |
EndPoint
The System.DateTime end point for real-time simulation
Declaration
public DateTime? EndPoint { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
GeoJsonOptions
Gets or sets the input/output options, specifying everything around processing of GeoJson files.
Declaration
public GeoJsonOptions GeoJsonOptions { get; set; }
Property Value
Type | Description |
---|---|
GeoJsonOptions |
InputOutputOptions
Gets or sets the input output options for connected services.
Declaration
public AbstractOptions InputOutputOptions { get; }
Property Value
Type | Description |
---|---|
AbstractOptions |
IsRealtimeRelated
Indicates whether this sim config has real-time reference
Declaration
public bool IsRealtimeRelated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
LiveVisualization
Declaration
public bool LiveVisualization { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
MongoOptions
Gets or sets the output options, specifying everything around the selected
OutputTarget.DocumentStore
Declaration
public MongoOptions MongoOptions { get; set; }
Property Value
Type | Description |
---|---|
MongoOptions |
OptionSet
Gets all available and assigned options of this simulation inputConfiguration.
Declaration
public IEnumerable<AbstractOptions> OptionSet { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<AbstractOptions> |
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
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).
PostgresSqlOptions
Gets or sets the output options, specifying everything around the selected
PostgresSql for the OutputTarget
Declaration
public PostgresSqlOptions PostgresSqlOptions { get; set; }
Property Value
Type | Description |
---|---|
PostgresSqlOptions |
RedisOptions
Gets or sets the options for the redis key-value mapper
Declaration
public RedisOptions RedisOptions { get; set; }
Property Value
Type | Description |
---|---|
RedisOptions |
ReportProgress
Gets or sets the flag whether to activate progress report over websocket.
Declaration
public bool ReportProgress { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
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
public bool ShowConsoleProgress { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SocketOutputOptions
Gets or sets the output options, specifying everything around the selected
OutputTarget.GeoJsonSocket ,
OutputTarget.Socket
Declaration
public SocketOutputOptions SocketOutputOptions { get; set; }
Property Value
Type | Description |
---|---|
SocketOutputOptions |
SpatialGraphOptions
Gets or sets the option set used to create the ISpatialGraphEnvironment.
Declaration
public SpatialGraphOptions SpatialGraphOptions { get; set; }
Property Value
Type | Description |
---|---|
SpatialGraphOptions |
Speed
Gets or sets the speed in percentage 0-100% setting the simulation speed to maximum (100%) or stop the run (0%).
Declaration
public double? Speed { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Double> |
SqLiteOptions
Gets or sets the output options, specifying everything around the selected
SqLite for the OutputTarget
Declaration
public SqLiteOptions SqLiteOptions { get; set; }
Property Value
Type | Description |
---|---|
SqLiteOptions |
StartPoint
The System.DateTime start point for real-time simulation
Declaration
public DateTime? StartPoint { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.DateTime> |
StartStep
Gets or sets the starting tick
Declaration
public int? StartStep { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
Steps
The full amount of steps to simulate
Declaration
public long? Steps { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
Ticks
The alternative description for Steps
Declaration
public long? Ticks { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int64> |
TripsOptions
Gets or sets the options used when serializing trajectories of entities.
Declaration
public TripsOptions TripsOptions { get; set; }
Property Value
Type | Description |
---|---|
TripsOptions |