• Documentation
  • 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>
      • 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
    • 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 Route

    Represents the common route object keeping all path information's of an individual ISpatialGraphEnvironment entity.
    Inheritance
    IEnumerable<EdgeStop>
    Route
    Implements
    IEquatable<Route>
    Namespace: Mars.Interfaces.Environments
    Assembly: Mars.Interfaces.dll
    Syntax
    public sealed class Route : IEnumerable<EdgeStop>, IEquatable<Route>

    Constructors

    Route(Route)

    Creates a new Route with new EdgeStops from another one with all the properties and stops.
    Declaration
    public Route(Route route)
    Parameters
    Type Name Description
    Route route The route from which to create new one.

    Route(Boolean)

    Creates an empty route without any stops.
    Declaration
    public Route(bool useGabBuffer = true)
    Parameters
    Type Name Description
    System.Boolean useGabBuffer

    Properties

    Count

    Gets the amount of stops of this route.
    Declaration
    public int Count { get; }
    Property Value
    Type Description
    System.Int32

    Goal

    The goal position of the route.
    Declaration
    public Position Goal { get; }
    Property Value
    Type Description
    Position

    GoalReached

    Gets the flag indicating whether the goal on this route was reached when the corresponding edge, the desired lane and the position on this edge has been arrived.
    Declaration
    public bool GoalReached { get; }
    Property Value
    Type Description
    System.Boolean

    Item[Int32]

    Gets the EdgeStop at the desired index. When moving actions was already be performed this access will give the current not passed stop.
    Declaration
    public EdgeStop this[int index] { get; }
    Parameters
    Type Name Description
    System.Int32 index The index of the rest route.
    Property Value
    Type Description
    EdgeStop

    PassedStops

    Gets the rest amount of stops to pass to reach the goal.
    Declaration
    public int PassedStops { get; }
    Property Value
    Type Description
    System.Int32

    RemainingRouteDistanceToGoal

    Gets the rest distance to pass until the goal is reached on the last EdgeStop.
    Declaration
    public double RemainingRouteDistanceToGoal { get; }
    Property Value
    Type Description
    System.Double

    RouteLength

    Gets the whole length of this route from start to end.
    Declaration
    public double RouteLength { get; }
    Property Value
    Type Description
    System.Double

    Stops

    The ordered path of all stops, planed by the routing component.
    Declaration
    public IList<EdgeStop> Stops { get; }
    Property Value
    Type Description
    IList<EdgeStop>

    Methods

    Add(ISpatialEdge, Int32)

    Adds a new edge stop to the route
    Declaration
    public void Add(ISpatialEdge edge, int lane = null)
    Parameters
    Type Name Description
    ISpatialEdge edge The underlying road segment
    System.Int32 lane The lane which shall be used.

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean

    GetEnumerator()

    Returns an enumerator that iterates through the collection.
    Declaration
    public IEnumerator<EdgeStop> GetEnumerator()
    Returns
    Type Description
    IEnumerator<EdgeStop> An enumerator that can be used to iterate through the collection of EdgeStop.

    GetHashCode()

    Serves as the default hash function.
    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32 A hash code for the current route.

    InsertFirst(ISpatialEdge, Int32, Nullable<DirectionType>)

    Inserts a new edge to the beginning of the route.
    Declaration
    public void InsertFirst(ISpatialEdge edge, int lane = null, DirectionType? directionType = null)
    Parameters
    Type Name Description
    ISpatialEdge edge The underlying road segment
    System.Int32 lane The lane which shall be used.
    System.Nullable<DirectionType> directionType The direction to take (up, down, ...)

    JumpToGoal()

    Directly finished the route and move to goal.
    Declaration
    public void JumpToGoal()

    Implements

    IEquatable<>

    Extension Methods

    SpatialGraphHelper.ToFeature(Route)
    SpatialGraphHelper.ToGeoJson(Route)
    Back to top Copyright © MARS GROUP.
    HAW Hamburg