Class TypeMapping

The mapping for a whole type to initialize an agent or layer via an input file or through a known metadata id. Can be associated with an individual IndividualMapping to fine grained match the parameters to inputs
Inheritance
System.Object
IdentifiableElement
TypeMapping
ActiveTypeMapping
EntityMapping
Inherited Members
System.Object.Equals(System.Object, System.Object)
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 abstract class TypeMapping : IdentifiableElement

Properties

| Improve this Doc View Source

DataContainer

The input data container with all possible input files.
Declaration
[JsonIgnore]
public IDataContainer DataContainer { get; set; }
Property Value
Type Description
IDataContainer
| Improve this Doc View Source

File

The path to the input file for this model type
Declaration
[JsonProperty("file", NullValueHandling = NullValueHandling.Ignore)]
public string File { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

IndividualMapping

The mapping to match individual parameters to a specific input field or explicit value
Declaration
[JsonProperty("individual", NullValueHandling = NullValueHandling.Ignore)]
public List<IndividualMapping> IndividualMapping { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IndividualMapping>
| Improve this Doc View Source

InputConfiguration

Gets or sets the temporal input configurations used to separate input and select temporal reference fields, when input is changing over time.
Declaration
[JsonProperty("inputConfiguration", NullValueHandling = NullValueHandling.Ignore)]
public InputConfiguration InputConfiguration { get; set; }
Property Value
Type Description
InputConfiguration
| Improve this Doc View Source

Inputs

Gets all associated data sources to process this type
Declaration
[JsonProperty("inputs", NullValueHandling = NullValueHandling.Ignore)]
public List<Input> Inputs { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Input>
| Improve this Doc View Source

IsTemporalChanging

The mapping for a whole type to initialize an agent or layer via an input file or through a known metadata id. Can be associated with an individual IndividualMapping to fine grained match the parameters to inputs
Declaration
[JsonIgnore]
public bool IsTemporalChanging { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LiveVisualization

The mapping for a whole type to initialize an agent or layer via an input file or through a known metadata id. Can be associated with an individual IndividualMapping to fine grained match the parameters to inputs
Declaration
[JsonProperty("pythonVisualization", NullValueHandling = NullValueHandling.Ignore)]
public bool? LiveVisualization { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
| Improve this Doc View Source

LiveVisualizationWithProperties

The mapping for a whole type to initialize an agent or layer via an input file or through a known metadata id. Can be associated with an individual IndividualMapping to fine grained match the parameters to inputs
Declaration
[JsonProperty("pythonVisualizationWithProperties", NullValueHandling = NullValueHandling.Ignore)]
public bool LiveVisualizationWithProperties { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ModelType

The source model type to map
Declaration
[JsonIgnore]
public abstract TypeElement ModelType { get; }
Property Value
Type Description
TypeElement
| Improve this Doc View Source

OutputFilter

Output filter predicates associated by an logical AND. When the agent matches all filter predicates then it will be persisted.
Declaration
[JsonProperty("outputFilter", NullValueHandling = NullValueHandling.Ignore)]
public List<OutputFilter> OutputFilter { get; set; }
Property Value
Type Description
System.Collections.Generic.List<OutputFilter>
| Improve this Doc View Source

OutputFrequency

The output frequency to specify how often the result data of this instances shall be write out. Default is 1.
Declaration
[JsonProperty("outputFrequency", NullValueHandling = NullValueHandling.Ignore)]
public int OutputFrequency { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

OutputKind

Gets or sets the output kind, whether all full snapshot shall be created (including ignored or not), only deltas (if possible) or only when something has been changed.
Declaration
[JsonProperty("outputKind", NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(OutputKindConverter))]
public OutputKind? OutputKind { get; set; }
Property Value
Type Description
System.Nullable<OutputKind>
| Improve this Doc View Source

Outputs

Gets all associated data sources to process this type
Declaration
[JsonProperty("outputs", NullValueHandling = NullValueHandling.Ignore)]
public List<Output> Outputs { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Output>
| Improve this Doc View Source

OutputTarget

Gets or sets the output target used for this type explicitly
Declaration
[JsonProperty("output", NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(OutputTargetConverter))]
public OutputTargetType? OutputTarget { get; set; }
Property Value
Type Description
System.Nullable<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

OutputTicks

The output ticks, when the result data of this instances shall be write out. Default is always (null).
Declaration
[JsonProperty("outputTicks", NullValueHandling = NullValueHandling.Ignore)]
public HashSet<long> OutputTicks { get; set; }
Property Value
Type Description
System.Collections.Generic.HashSet<System.Int64>
| Improve this Doc View Source

ParameterMapping

The mapping for a whole type to initialize an agent or layer via an input file or through a known metadata id. Can be associated with an individual IndividualMapping to fine grained match the parameters to inputs
Declaration
[JsonIgnore]
public IDictionary<string, IndividualMapping> ParameterMapping { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, IndividualMapping>
| Improve this Doc View Source

Processing

Gets all processing source for the model runtime.
Declaration
[JsonProperty("processing", NullValueHandling = NullValueHandling.Ignore)]
public List<Processing> Processing { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Processing>
| Improve this Doc View Source

Value

Gets or sets a value e.g., geojson content assigned to this vector-layer
Declaration
[JsonProperty("value", NullValueHandling = NullValueHandling.Ignore)]
public object Value { get; set; }
Property Value
Type Description
System.Object

Extension Methods