Package com.esri.arcgisruntime.tasks.networkanalysis

Class Route

  • public final class Route
extends java.lang.Object
    Represents an independent route within a RouteResult.
    Since:
    100.0.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double getCost​(java.lang.String attributeName)
      Gets the cost for the given attribute.
      java.util.List<DirectionManeuver> getDirectionManeuvers()
      Gets the turn-by-turn driving directions along this route.
      java.util.Calendar getEndTime()
      Gets the time when the route ends (arriving at the last stop).
      double getEndTimeShift()
      Gets shift for end time.
      Polyline getRouteGeometry()
      Gets the route geometry.
      java.lang.String getRouteName()
      Gets the route name.
      java.util.Calendar getStartTime()
      Gets the time when the route begins (departing from the first stop).
      double getStartTimeShift()
      Gets shift for start time.
      java.util.List<Stop> getStops()
      Gets the stops visited along this route.
      double getTotalLength()
      Gets the total length of the Route in meters.
      double getTotalTime()
      Gets the overall time (in minutes) taken by the route from start to end.
      double getTravelTime()
      Gets the time (in minutes) to travel along the route.
      double getViolationTime()
      Gets the total number of minutes that exceed the permissible time windows for stops on this route, based on calculated arrival time at all the stops.
      double getWaitTime()
      Gets the time (in minutes) spent at stops waiting for time windows to open.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getRouteGeometry

        public Polyline getRouteGeometry()
        Gets the route geometry.
        Returns:
        the route geometry
        Since:
        100.0.0

      • getRouteName

        public java.lang.String getRouteName()
        Gets the route name. Same as Stop.getRouteName() of the stops included in this route.
        Returns:
        the route name
        Since:
        100.0.0

      • getCost

        public double getCost​(java.lang.String attributeName)
        Gets the cost for the given attribute.
        Parameters:
        attributeName - attribute name
        Returns:
        the cost
        Throws:
        java.lang.IllegalArgumentException - if attributeName is null
        ArcGISRuntimeException - if attributeName is invalid
        Since:
        100.0.0

      • getTravelTime

        public double getTravelTime()
        Gets the time (in minutes) to travel along the route.
        Returns:
        the travel time
        Since:
        100.0.0

      • getTotalTime

        public double getTotalTime()
        Gets the overall time (in minutes) taken by the route from start to end. This includes getTravelTime() and getWaitTime().
        Returns:
        the total time
        Since:
        100.0.0

      • getWaitTime

        public double getWaitTime()
        Gets the time (in minutes) spent at stops waiting for time windows to open. Only applicable if time windows were specified for stops. Stop.setTimeWindowStart(Calendar) and Stop.setTimeWindowEnd(Calendar) can be used for specifying the time windows
        Returns:
        the wait time
        Since:
        100.0.0

      • getViolationTime

        public double getViolationTime()
        Gets the total number of minutes that exceed the permissible time windows for stops on this route, based on calculated arrival time at all the stops. Only applicable if time windows were specified for stops.

        Stop.setTimeWindowStart(Calendar) and Stop.setTimeWindowEnd(Calendar) can be used for specifying the time windows

        Returns:
        the violation time
        Since:
        100.0.0

      • getStartTime

        public java.util.Calendar getStartTime()
        Gets the time when the route begins (departing from the first stop).
        Returns:
        the local start time. Returns null if the local start time was not set in RouteParameters.setStartTime(Calendar)
        Since:
        100.0.0

      • getStartTimeShift

        public double getStartTimeShift()
        Gets shift for start time.
        Returns:
        a value of time zone shift in minutes
        Since:
        100.0.0

      • getEndTime

        public java.util.Calendar getEndTime()
        Gets the time when the route ends (arriving at the last stop).
        Returns:
        the local end time. Returns null if the local start time was not set in set in RouteParameters
        Since:
        100.0.0

      • getEndTimeShift

        public double getEndTimeShift()
        Gets shift for end time.
        Returns:
        a value of time zone shift in minutes
        Since:
        100.0.0

      • getTotalLength

        public double getTotalLength()
        Gets the total length of the Route in meters.
        Returns:
        the total route length in meters
        Since:
        100.0.0