Class ClosestFacilityRoute


  • public final class ClosestFacilityRoute
    extends Object
    Represents an independent closest facility route within a ClosestFacilityResult.
    Since:
    100.1.0
    • Method Detail

      • getRouteGeometry

        public Polyline getRouteGeometry()
        Gets the route's geometry.
        Returns:
        the route's geometry
        Since:
        100.1.0
      • getTravelTime

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

        public double getTotalTime()
        Gets the overall time (in minutes) taken by the route from start to end.
        Returns:
        the total time
        Since:
        100.1.0
      • getStartTimeShift

        public double getStartTimeShift()
        Gets the shift for start time.
        Returns:
        a value of time zone shift in minutes
        Since:
        100.1.0
        See Also:
        getStartTime()
      • getEndTime

        public Calendar getEndTime()
        Gets the time when the route ends (arriving at the last facility or incident).
        Returns:
        the local end time. Returns null if the local start time was not set in set in ClosestFacilityParameters
        Since:
        100.1.0
      • getEndTimeShift

        public double getEndTimeShift()
        Gets the shift for end time.
        Returns:
        a value of time zone shift in minutes
        Since:
        100.1.0
        See Also:
        getEndTime()
      • getTotalLength

        public double getTotalLength()
        Gets the total length of the ClosestFacilityRoute in meters.
        Returns:
        the total route length in meters
        Since:
        100.1.0
      • getCost

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