Class AbstractFileOptions
Provides the base options for all file-based inputs/output.
Inheritance
System.Object
AbstractFileOptions
Implements
System.IDisposable
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.Options
Assembly: Mars.Interfaces.dll
Syntax
public abstract class AbstractFileOptions : AbstractOptions, IDisposable
Constructors
| Improve this Doc View SourceAbstractFileOptions()
Provides the base options for all file-based inputs/output.
Declaration
public AbstractFileOptions()
Properties
| Improve this Doc View SourceChunkSize
Gets or sets the chunk size for UTF8 values serialization
As values will be written into a file directly this need additional I/O
which will often be grouped into greater chunks, to write only once.
Default is = 4096
Declaration
[JsonProperty("chunkSize", NullValueHandling = NullValueHandling.Ignore)]
public int ChunkSize { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
DistinctFiles
Gets or sets a flag indicating, that each output shall be separated by one file. That means
for each output an individual *.geojson file will be created.
Declaration
[JsonProperty("distinctFiles", NullValueHandling = NullValueHandling.Ignore)]
public bool DistinctFiles { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Encoding
Gets or sets the encoding, so in which text code format value shall be serialized.
Declaration
[JsonProperty("encoding", NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(EncodingConverter))]
public Encoding Encoding { get; set; }
Property Value
Type | Description |
---|---|
System.Text.Encoding |
FileSuffix
Gets or sets the suffix what shall be append to the output CSV file to distinguish multiple results.
Default is empty suffix so that the result file is named according to the type name.
Declaration
[JsonProperty("fileSuffix", NullValueHandling = NullValueHandling.Ignore)]
public string FileSuffix { get; set; }
Property Value
Type | Description |
---|---|
System.String |
OutputPath
Gets or sets the relative output path used to create simulation results.
Declaration
[JsonProperty("outputPath", NullValueHandling = NullValueHandling.Ignore)]
public string OutputPath { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Implements
System.IDisposable