Package com.trimblemaps.navigation.base.trip.model

Enum RouteProgressState

  • All Implemented Interfaces:
    java.io.Serializable , kotlin.Comparable 
    
public enum RouteProgressState
extends Enum<RouteProgressState>

    Contains the various progress states that can occur while navigating.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ROUTE_INVALID

      The com.trimblemaps.api.directions.v1.models.DirectionsRoute provided via com.trimblemaps.navigation.core.TrimbleMapsNavigation.setRoutes when in Active Guidance is not valid.
      ROUTE_INITIALIZED

      The DirectionsRoute is valid and com.trimblemaps.navigation.core.TrimbleMapsNavigation is waiting for sufficient android.location.Location updates from the com.trimblemaps.android.core.location.LocationEngine.
      ROUTE_COMPLETE

      The user has arrived at the destination of the given com.trimblemaps.api.directions.v1.models.RouteLeg.
      LOCATION_TRACKING

      com.trimblemaps.navigation.core.TrimbleMapsNavigation is now confidently tracking the location updates and processing them against the route.
      LOCATION_STALE

      A lack of android.location.Location updates has caused a lack of confidence in the progress updates being sent.
      OFF_ROUTE

      State when we detect an off-route.
      OFF_ROUTE_OFF_GRID

      State when we detect an off-route and outside of grid, with no network connection
      ROUTE_UNCERTAIN

      State when we start following a route.

      After a certain number of tracking points, we gain confidence and switch to tracking state. We do map-matching rather than route line snapping during this state.

    • Method Summary

      Modifier and Type Method Description
      final RouteProgressState valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<RouteProgressState> values() Returns an array containing the constants of this enum type, in the order they're declared.

      • Methods inherited from class kotlin.Enum

        getName, getOrdinal

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • valueOf

         final RouteProgressState valueOf(String value)

        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.)

      • values

         final Array<RouteProgressState> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.