• MARS Website
  • Core API
  • SmartOpenHamburg API
  • Model Components API
  • Common API
Show / Hide Table of Contents
  • Mars.Components
    • DependencyRegistrationModelling
  • Mars.Components.Agents
    • AbstractAgent
    • AbstractEntity
    • Agent
  • Mars.Components.Environments
    • AbstractEnvironment
    • AbstractGraphElement
    • AlwaysPassingNodeGuard
    • EntityLane<TEntity>
    • GeoEnvironment
    • GeoHashEnvironment<T>
    • IEnvironmentMediator
    • IModalChoiceResolver
    • PathHeuristics
    • SpatialEdge
    • SpatialGraphEntityExtensions
    • SpatialGraphEnvironment
    • SpatialGraphHelper
    • SpatialHashEnvironment<TEntity>
    • SpatialLane
    • SpatialNode
    • WorldIndexExtensions
  • Mars.Components.Environments.Cartesian
    • CartesianEnvironment<TEntity>
    • CollisionEnvironment<TCharacter, TObstacle>
    • CollisionKind
    • ConeExplorationView
    • ExplorationView
    • GeometryFactory
    • ICartesianEnvironment<TEntity>
    • ICharacter
    • ICollidable
    • ICollisionEnvironment<TCharacter, TObstacle>
    • IObstacle
    • IVisible
    • RayExplorationView
    • TrapezoidExploration
    • VisibilityKind
  • Mars.Components.Environments.Cartesian.Routing
    • CartesianRoutingService<TObstacle>
    • GeometryCoordinatesRoutingPointsGenerator
    • HomogenousRoutingPointsGenerator
    • IRoutingPointsGenerator
    • RandomRoutingPointsGenerator
    • SectionalRandomRoutingPointsGenerator
  • Mars.Components.Layers
    • AbstractActiveLayer
    • AbstractEnvelopedLayer
    • AbstractLayer
    • AbstractVectorFeature
    • AgentSchedulerLayer<TAgent, TLayer>
    • QuerySourceLoader
    • RasterLayer
    • SchedulerEntry
    • SchedulerLayer
    • VectorFeature
    • VectorLayer
    • VectorLayer<T>
    • VectorLayerHelper
  • Mars.Components.Layers.Temporal
    • IQueryFieldProvider
    • ITemporalObjectCatalog
    • ITemporalObjectIterator
    • TemporalCatalogFeature<TKey>
    • TemporalFeatureKind
    • TemporalMetadataLoader
  • Mars.Components.Services
    • AgentManager
  • Mars.Components.Services.Explorations
    • BoltzmannExploration
    • EpsilonGreedyExploration
    • IExplorationPolicy
    • RouletteWheelExploration
    • TabuSearchExploration
  • Mars.Components.Services.Learning
    • InfiniteQLearning
    • QLearning
    • Sarsa
  • Mars.Components.Services.Planning
    • ActionPlanResult
    • GoapAction
    • GoapAgentStates
    • GoapGoal
    • GoapPlanner
    • GoapStateKey<T>
    • GoapStateProperty
    • GoapStateProperty<TElement>
    • IGoapAction
    • IGoapAgentStates
    • IGoapGoal
    • IGoapPlanner
    • IGoapStateKey
    • StatesCommons
  • Mars.Components.Services.Planning.ActionCommons
    • AllGoalsSatisfiedAction
    • NoGoalReachableAction
  • Mars.Components.Starter
    • Command
    • CommandArgumentContainer
    • CommandParser
    • CommandSet
    • HelpCommand
    • Option
    • OptionContext
    • OptionException
    • OptionSet
    • OptionValueCollection
    • OptionValueType
    • SimulationStarter
  • Mars.Components.Starter.Exceptions
    • SimulationStartupException
  • Mars.Interfaces
    • IModelObject
    • ISimulationContainer
    • ISimulationContext
    • ISimulationModule
    • ISimulationState
    • IStepExecutionContext
    • SimulationContext
    • SimulationContext.WorkflowStateType
    • StepExecutionContext
  • Mars.Interfaces.Agents
    • IAgent
    • IAgent<TLayer>
    • IEntity
    • IMarsDslAgent
    • IModalCapabilitiesAgent
    • ISpatialGraphEntity
    • ITickClient
  • Mars.Interfaces.Annotations
    • ActiveConstructor
    • PropertyDescription
  • Mars.Interfaces.Data
    • AbstractDomainData
    • GeometryData
    • IDomainData
    • IGeometryData
    • IIdentifiableData
    • IMarsFeature
    • IRasterBandData
    • ISource
    • IStringData
    • IStringStructuredData
    • IStructuredData
    • IStructuredDataGeometry
    • IValueData
    • LayerInitData
    • RasterBandData
    • StringDataDto
    • StructuredData
    • VectorStructuredData
  • Mars.Interfaces.Environments
    • BoundingBox
    • DirectionType
    • EdgeExploreResult
    • EdgeStop
    • ExploreDirection
    • GeoPositionExtension
    • HighwayType
    • IEdge<TEdge, TNode>
    • IEntityLane<TEntity>
    • IEnvironment
    • IEnvironment<TEntity>
    • IGeoGridEnvironment<T>
    • IGraphEntity
    • IGraphEnvironment<TEdge, TNode>
    • INode<TEdge, TNode>
    • INodeGuard
    • IPositionable
    • IRoutePlanner
    • ISpatialEdge
    • ISpatialGraphEnvironment
    • ISpatialLane
    • ISpatialNode
    • LaneExploreResult
    • ModalChoice
    • MultimodalRoute
    • NodeIntegrationKind
    • Position
    • Route
    • RouteStop
    • Size
    • SpatialGraphExploreResult
    • SpatialModalityType
    • TrafficLightPhase
  • Mars.Interfaces.Layers
    • FinallySimulationStep
    • IChangingLayer
    • IDataContainer
    • IDataLayer
    • IDataSet
    • IEnvelopDataLayer
    • ILayer
    • IMarsDslLayer
    • IModalChoiceConsumer
    • InitSimulationStep
    • INotifyChangedSource<T>
    • IRaster<TValue>
    • IRasterLayer
    • ISteppedActiveLayer
    • IVectorFeature
    • IVectorLayer
    • IVectorLayer<T>
    • IVectorNode<TEntity>
    • RegisterAgent
    • UnregisterAgent
  • Mars.Interfaces.Model
    • ActiveTypeMapping
    • AgentMapping
    • AgentType
    • ConstructorType
    • ContainsOperator
    • DataContainer
    • DataType
    • EntityMapping
    • EntityType
    • Execution
    • FeatureType
    • Globals
    • IdentifiableElement
    • IndividualMapping
    • Input
    • InputConfiguration
    • LayerMapping
    • LayerType
    • ModelDescription
    • ModelElement
    • ObjectType
    • Output
    • OutputConfiguration
    • OutputFilter
    • OutputKind
    • OutputTargetType
    • ParameterMapping
    • Processing
    • ProcessingConfiguration
    • ProcessingTargetType
    • PropertyType
    • SimulationConfig
    • TimeSpanUnit
    • TimeSpanUnitExtensions
    • TypeElement
    • TypeMapping
  • Mars.Interfaces.Model.Converters
    • CultureConverter
    • SerializationTypeConverter
    • TimeSpanUnitConverter
  • Mars.Interfaces.Model.Exceptions
    • InvalidTypeException
    • MissingTypeException
  • Mars.Interfaces.Model.Options
    • AbstractEndpointOptions
    • AbstractFileOptions
    • AbstractOptions
    • AscOptions
    • CsvOptions
    • GeoJsonOptions
    • MongoOptions
    • MqttOptions
    • PostgresSqlOptions
    • RedisOptions
    • RelationalEndpointOptions
    • SerializationType
    • SocketOutputOptions
    • SpatialGraphOptions
    • SqLiteOptions
    • TripsOptions

Class InputConfiguration

This class provides multiple settings for all input related stuff, how to read the individual input objects from a specified Input,
Inheritance
System.Object
AbstractOptions
AbstractEndpointOptions
InputConfiguration
Implements
System.IDisposable
Inherited Members
AbstractEndpointOptions.DefaultHost
AbstractEndpointOptions.DefaultDatabase
AbstractEndpointOptions.Host
AbstractEndpointOptions.Port
AbstractEndpointOptions.HostUserName
AbstractEndpointOptions.HostPassword
AbstractEndpointOptions.ConnectionTimeout
AbstractEndpointOptions.DatabaseName
AbstractEndpointOptions.TryNormalize
AbstractEndpointOptions.DistinctTable
AbstractEndpointOptions.OverrideByConflict
AbstractEndpointOptions.UsingInMemory
AbstractEndpointOptions.OutputPath
AbstractOptions.GlobalConfig
AbstractOptions.CultureInfo
AbstractOptions.NumberFormat
AbstractOptions.Dispose()
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
[MessagePackObject(true)]
public class InputConfiguration : AbstractEndpointOptions, IDisposable

Properties

| Improve this Doc View Source

BrokerHostName

Gets or sets the host e.g. "iot.hamburg.de" without any protocol specification.
Declaration
[JsonProperty("mqttBrokerHostName", NullValueHandling = NullValueHandling.Ignore)]
public string BrokerHostName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

DelegateProcessingContext

An optional processing context when importing data, can be assigned with any object in order to include processing within delegates. Associated all processing context as parameters is much more memory efficient .
Declaration
public IDictionary<int, object> DelegateProcessingContext { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.Int32, System.Object>
| Improve this Doc View Source

Delimiter

Gets or sets the delimiter to separate the CSV input file.
Declaration
[JsonProperty("delimiter")]
public char Delimiter { get; set; }
Property Value
Type Description
System.Char
| Improve this Doc View Source

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
| Improve this Doc View Source

File

Gets or sets the source graph for the global spatial graph
Declaration
[JsonProperty("file", NullValueHandling = NullValueHandling.Ignore)]
public string File { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

GeometryAsNodesEnabled

Gets or sets the flag to import the geometric curves as own ISpatialNode. Default is INACTIVE(false)
Declaration
[JsonProperty("geometryAsNodesEnabled")]
public bool GeometryAsNodesEnabled { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

GeometryColumnName

Gets or set an optional name of the field used to retrieve a geometry information from the CSV.
Declaration
[JsonProperty("geometryAttributeName")]
public string GeometryColumnName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

HasHeader

Gets or sets a flag, indicating that this input source has header
Declaration
[JsonProperty("hasHeader")]
public bool HasHeader { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

InferHelperNodeWithinRadiusInM

This import configuration checks if edges are within the given tolerance range of a node, if so, they are separated, a helper node is inserted and this one is connected to the original node.
Declaration
[JsonProperty("inferHelperNodeWithinRadiusInM")]
public float? InferHelperNodeWithinRadiusInM { get; set; }
Property Value
Type Description
System.Nullable<System.Single>
| Improve this Doc View Source

InferNodesOnEdgeIntersections

This ISpatialGraphEnvironment import configuration checks if edges intersect and if so, connect both edges by splitting the edges at the intersection point and insert two part-edges instead of one.
Declaration
[JsonProperty("inferNodesOnEdgeIntersections")]
public bool InferNodesOnEdgeIntersections { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsBiDirectedImport

Gets or sets the flag indicating that this graph has no direction where each edge needs to be imported in both directions.
Declaration
[JsonProperty("isBidirectedGraph")]
public bool IsBiDirectedImport { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsGridRaster

Gets or sets the flag indicating that this CSV input is interpreted as 2D grid.
Declaration
[JsonProperty("isRaster")]
public bool IsGridRaster { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTemporalChanging

This class provides multiple settings for all input related stuff, how to read the individual input objects from a specified Input,
Declaration
[JsonIgnore]
public bool IsTemporalChanging { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Modalities

Gets or sets all associated modalities moving on the edges of this graph.
Declaration
[JsonProperty("modalities", NullValueHandling = NullValueHandling.Ignore)]
public ISet<SpatialModalityType> Modalities { get; set; }
Property Value
Type Description
System.Collections.Generic.ISet<SpatialModalityType>
| Improve this Doc View Source

NodeIntegrationKind

Gets or sets the kind how nearest or similar nodes shall be handled in the spatial graph.
Declaration
[JsonProperty("nodeIntegrationKind")]
public NodeIntegrationKind NodeIntegrationKind { get; set; }
Property Value
Type Description
NodeIntegrationKind
| Improve this Doc View Source

NodeToleranceInMeter

Gets or sets the tolerance in meter to resolve for existing nodes A higher value indicates a higher radius in which to look for already inserted nodes Default is 10 meter
Declaration
[JsonProperty("nodeTolerance", NullValueHandling = NullValueHandling.Ignore)]
public float? NodeToleranceInMeter { get; set; }
Property Value
Type Description
System.Nullable<System.Single>
| Improve this Doc View Source

NoHelperNodes

Imports all nodes first and always uses these as start and goal nodes for the edges. No additional helper nodes are created.
Declaration
[JsonProperty("noHelperNodes", NullValueHandling = NullValueHandling.Ignore)]
public bool NoHelperNodes { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

PointColumnNames

Gets or sets the names of columns when resolving a 2D/3D point from multiple columns.
Declaration
[JsonProperty]
public string[] PointColumnNames { get; set; }
Property Value
Type Description
System.String[]
Remarks
When the point is provides as single data value such as well-known-text with POINT(0 1)
| Improve this Doc View Source

SourcePropertyName

Gets or sets the source property name used to retrieve information from the incoming SensorThingsEndpoint.
Declaration
[JsonProperty("sourceProperty", NullValueHandling = NullValueHandling.Ignore)]
public string SourcePropertyName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

StreamTopicPattern

Gets or sets the topic query pattern used to participate the model object to a MQTT data-stream.
Declaration
[JsonProperty("mqttTopicPattern", NullValueHandling = NullValueHandling.Ignore)]
public string StreamTopicPattern { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

TargetPropertyName

Gets or sets the property name to use when updates get received from the SensorThingsEndpoint.
Declaration
[JsonProperty("targetProperty", NullValueHandling = NullValueHandling.Ignore)]
public string TargetPropertyName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

TemporalJoinReference

This class provides multiple settings for all input related stuff, how to read the individual input objects from a specified Input,
Declaration
[JsonProperty("temporalJoinAttribute", NullValueHandling = NullValueHandling.Ignore)]
public string TemporalJoinReference { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

TemporalSourceAttribute

This class provides multiple settings for all input related stuff, how to read the individual input objects from a specified Input,
Declaration
[JsonProperty("temporalSourceAttribute", NullValueHandling = NullValueHandling.Ignore)]
public string TemporalSourceAttribute { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ValidTimeAtAttributeName

This class provides multiple settings for all input related stuff, how to read the individual input objects from a specified Input,
Declaration
[JsonProperty("validTimeAtAttribute", NullValueHandling = NullValueHandling.Ignore)]
public string ValidTimeAtAttributeName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ValidTimeFromAttributeName

This class provides multiple settings for all input related stuff, how to read the individual input objects from a specified Input,
Declaration
[JsonProperty("validTimeFromAttribute", NullValueHandling = NullValueHandling.Ignore)]
public string ValidTimeFromAttributeName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ValidTimeToAttributeName

This class provides multiple settings for all input related stuff, how to read the individual input objects from a specified Input,
Declaration
[JsonProperty("validTimeToAttribute", NullValueHandling = NullValueHandling.Ignore)]
public string ValidTimeToAttributeName { get; set; }
Property Value
Type Description
System.String

Implements

System.IDisposable

Extension Methods

Serializer.Save<T>(T, out Byte[], SerializerCompression)
Serializer.Save<T>(T, Stream, SerializerCompression)
Serializer.Save<T>(T, BinaryFormatter, Stream, SerializerCompression)
Serializer.Save<T>(T, String, SerializerCompression)
Serializer.Save<T>(T, String)
Matrix.Concatenate<T>(T, T[])
Matrix.Replace<T>(T, Object, Object)
DomainDataImporter.Import(Object, InputConfiguration)
ObjectSerialize.Serialize(Object)
Matrix.IsEqual(Object, Object, Decimal, Decimal)
  • Improve this Doc
  • View Source
In This Article
Back to top Copyright © MARS GROUP. HAW Hamburg