Enum DestinationStatus

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DestinationStatus>

    public enum DestinationStatus
    extends java.lang.Enum<DestinationStatus>
    The list of route tracking destination statuses. Used to determine how close the current location is to the next destination.
    Since:
    100.6.0
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      APPROACHING
      Approaching destination status.
      NOT_REACHED
      Not reached destination status.
      REACHED
      Reached destination status.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DestinationStatus valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DestinationStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NOT_REACHED

        public static final DestinationStatus NOT_REACHED
        Not reached destination status. Default value.
        Since:
        100.6.0
      • APPROACHING

        public static final DestinationStatus APPROACHING
        Approaching destination status.

        Value returned when provided GPS location gets within 500 meters of the next destination. This status can be used to manually call RouteTracker.switchToNextDestinationAsync() if a vehicle can not get closer to a destination to trigger a status of REACHED.

        Since:
        100.6.0
      • REACHED

        public static final DestinationStatus REACHED
        Reached destination status.

        Value returned when provided GPS location gets within 7-40 meters, along the route, of the next destination. Once within 40 meters of the next destination the vehicle is tracked to determine if it is getting closer or moving away from the next destination. If the vehicle continues to get closer this value will be returned when within 7 meter of the next destination, if the vehicle starts to move away this value is returned. This status can be used to automatically call RouteTracker.switchToNextDestinationAsync().

        Since:
        100.6.0
    • Method Detail

      • values

        public static DestinationStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (DestinationStatus c : DestinationStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DestinationStatus valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null