• 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
    • 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
      • AbstractDataLayer
      • AbstractLayer
      • AgentSchedulerLayer<TAgent, TLayer>
      • BoundDataSet
      • DisposeBase
      • MatrixRaster
      • QuerySourceLoader
      • Raster
      • Raster<TValue>
      • 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
      • IBoundedDataLayer
      • IChangingLayer
      • IDataContainer
      • IDataLayer
      • IDataSet
      • ILayer
      • IMarsDslLayer
      • IModalChoiceConsumer
      • InitSimulationStep
      • INotifyChangedSource<T>
      • IRaster
      • 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 MultimodalRoute

    Inheritance
    IEnumerable<RouteStop>
    MultimodalRoute
    Implements
    IEquatable<MultimodalRoute>
    Namespace: Mars.Interfaces.Environments
    Assembly: Mars.Interfaces.dll
    Syntax
    public class MultimodalRoute : IEnumerable<RouteStop>, IEquatable<MultimodalRoute>

    Constructors

    MultimodalRoute()

    Creates an empty route without any stops.
    Declaration
    public MultimodalRoute()

    MultimodalRoute(IEnumerable<RouteStop>)

    Creates a new planed route with an ordered collection of individual stops to take.
    Declaration
    public MultimodalRoute(IEnumerable<RouteStop> stops)
    Parameters
    Type Name Description
    IEnumerable<RouteStop> stops An ordered collection of stops with references to the environment.

    MultimodalRoute(Route, ModalChoice)

    Creates a multimodal route that contains given route with corresponding modal type.
    Declaration
    public MultimodalRoute(Route route, ModalChoice modalChoice)
    Parameters
    Type Name Description
    Route route First element of the multimodal route.
    ModalChoice modalChoice First modal type of the multimodal route

    Fields

    WalkingFilter

    Declaration
    protected static readonly Func<ISpatialEdge, bool> WalkingFilter
    Field Value
    Type Description
    Func<ISpatialEdge, System.Boolean>

    Properties

    Count

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

    CurrentModalChoice

    Declaration
    public ModalChoice CurrentModalChoice { get; }
    Property Value
    Type Description
    ModalChoice

    CurrentRoute

    Declaration
    public Route CurrentRoute { get; }
    Property Value
    Type Description
    Route

    Goal

    Declaration
    public Position Goal { get; }
    Property Value
    Type Description
    Position

    GoalReached

    Gets the flag indicating whether the goal of all routes that belong to the multimodal route are reached.
    Declaration
    public bool GoalReached { get; }
    Property Value
    Type Description
    System.Boolean

    Item[Int32]

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

    MainModalChoice

    Declaration
    public ModalChoice MainModalChoice { get; }
    Property Value
    Type Description
    ModalChoice

    PassedStops

    Defines how many stops are already passed.
    Declaration
    public int PassedStops { get; }
    Property Value
    Type Description
    System.Int32

    RouteLength

    Declaration
    public double RouteLength { get; }
    Property Value
    Type Description
    System.Double

    Start

    Declaration
    public Position Start { get; }
    Property Value
    Type Description
    Position

    Stops

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

    Methods

    Add(Route, ModalChoice)

    Adds a new route stop to the multimodal route
    Declaration
    public void Add(Route route, ModalChoice modalChoice)
    Parameters
    Type Name Description
    Route route A route part
    ModalChoice modalChoice The modal type that is used for given route

    AppendAndDeleteTail(MultimodalRoute)

    Appends a following multimodal route to the current multimodal route
    Declaration
    public void AppendAndDeleteTail(MultimodalRoute multimodalRoute)
    Parameters
    Type Name Description
    MultimodalRoute multimodalRoute Appending multimodal route, that finishes the track.

    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<RouteStop> GetEnumerator()
    Returns
    Type Description
    IEnumerator<RouteStop> An enumerator that can be used to iterate through the collection of RouteStop.

    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(Route, ModalChoice)

    Declaration
    public void InsertFirst(Route route, ModalChoice modalChoice)
    Parameters
    Type Name Description
    Route route
    ModalChoice modalChoice

    Next()

    Sets the pointer to the next RouteStop if it is not the last stop.
    Declaration
    public void Next()

    ToString()

    Converts this multimodal route into appropriate string representation.
    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String Returns the string representation of the multimodal route.

    Implements

    IEquatable<>
    Back to top Copyright © MARS GROUP.
    HAW Hamburg