RouteAlert (INRIX Mobile Client SDK

java.lang.Object
- com.inrix.sdk.RouteAlert

```
public class RouteAlert
extends Object
```
A highly specialized route tracking and incident detection mechanism which takes into account the user's current location and activity to provide route suggestions and incidents along the route periodically to the desired destination.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`enableBetterRouteAlerts(boolean enabled)` Enable or disable better route alerts.
`SimpleArrayMap<Incident,Double>`	`getIncidentsOnRouteWithDistance()` Gets a map of the incidents on the tracker route and their distances from the origin.
`double`	`getProgress()` Get the route progress as a percentage of the route completed/driven.
`double`	`getRemainingDistance()` Get the distance remaining on the route.
`double`	`getTotalRouteDistance()` Get the total route distance.
`int`	`getTotalRouteDistanceMeters()` Get the total route distance in meters.
`Route`	`getTrackedRoute()` Get the route that is currently being tracked.
`boolean`	`isAlertActive()` Get whether or not alert is active.
`void`	`setFilter(IFilter<Incident> filter)` Set the filter to filter incidents.
`void`	`setRoutesToUpdate(List<Route> routesToUpdate)` Set an array of `Route` to update.
`void`	`setRouteToTrack(Route routeToTrack)` Set a particular route to track.
`void`	`setUserDriving(boolean isUserDriving)` Set a default value to user driving state.
`void`	`start(Location currentLocation)` This method is used to start the route incident alert.
`void`	`stop()` This method is used to stop the route incident alert.
`void`	`updateCurrentLocation(Location currentLocation)` Updates the current location for route requests.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - updateCurrentLocation
```
public void updateCurrentLocation(Location currentLocation)
```
    Updates the current location for route requests. Users are responsible for supplying location updates.
    
    Parameters:
    currentLocation - The current location.
    
    Throws:
    
    InrixException - when currentLocation us null.
  - start
```
public void start(Location currentLocation)
```
    This method is used to start the route incident alert.
    
    Parameters:
    currentLocation - The current location.
  - stop
```
public void stop()
```
    This method is used to stop the route incident alert.
  - isAlertActive
```
public boolean isAlertActive()
```
    Get whether or not alert is active.
    
    Returns:
    true if active, false otherwise.
  - setFilter
```
public void setFilter(IFilter<Incident> filter)
```
    Set the filter to filter incidents.
    
    Parameters:
    filter - A new filter.
  - setRouteToTrack
```
public void setRouteToTrack(Route routeToTrack)
```
    Set a particular route to track. Note : will not actually track route unless you have started driving.
    
    Parameters:
    routeToTrack - The new route to track.
  - setRoutesToUpdate
```
public void setRoutesToUpdate(List<Route> routesToUpdate)
```
    Set an array of Route to update.
    
    Parameters:
    routesToUpdate - The routes to update.
  - getTrackedRoute
```
public Route getTrackedRoute()
```
    Get the route that is currently being tracked.
    
    Returns:
    The route that is being tracked.
  - getTotalRouteDistance
```
public double getTotalRouteDistance()
```
    Get the total route distance. The units of this value are based off of UserPreferences.getSettingUnits().
    
    Returns:
    The total route distance.
  - getTotalRouteDistanceMeters
```
public int getTotalRouteDistanceMeters()
```
    Get the total route distance in meters.
    
    Returns:
    The total route distance.
  - getIncidentsOnRouteWithDistance
```
public SimpleArrayMap<Incident,Double> getIncidentsOnRouteWithDistance()
```
    Gets a map of the incidents on the tracker route and their distances from the origin.
    
    Returns:
    Map of incident to distance from origin.
  - getRemainingDistance
```
public double getRemainingDistance()
```
    Get the distance remaining on the route. The units of this value are based off of UserPreferences.getSettingUnits().
    
    Returns:
    The remaining distance or -1 if unknown.
  - getProgress
```
public double getProgress()
```
    Get the route progress as a percentage of the route completed/driven.
    Example: 0.25 represents that 25% of the route has been driven, and 75% of the total route distance is remaining.
    
    Returns:
    The route progress or -1 if unknown.
  - enableBetterRouteAlerts
```
public void enableBetterRouteAlerts(boolean enabled)
```
    Enable or disable better route alerts. Default value is specified through RouteManager.UpdatedRouteOptions.setReturnBetterRoute(boolean) in the RouteManager.UpdatedRouteOptions provided to the constructor.
    
    Parameters:
    enabled - true to enabled better route alerts, false otherwise.
  - setUserDriving
```
public void setUserDriving(boolean isUserDriving)
```
    Set a default value to user driving state.
    
    Parameters:
    isUserDriving - Flag to pre select if a user is in a driving state.

Class RouteAlert

Method Summary

Methods inherited from class java.lang.Object

Method Detail

updateCurrentLocation

start

stop

isAlertActive

setFilter

setRouteToTrack

setRoutesToUpdate

getTrackedRoute

getTotalRouteDistance

getTotalRouteDistanceMeters

getIncidentsOnRouteWithDistance

getRemainingDistance

getProgress

enableBetterRouteAlerts

setUserDriving