com.inrix.sdk

Class RouteTracker

java.lang.Object

com.inrix.sdk.RouteTracker

public class RouteTracker
extends Object

A utility class used to track route progress and incidents along a route.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ON_ROUTE_TOLERANCE_DEFAULT_METERS Default threshold for considering a user "on route".

Constructor Summary

Constructors

Constructor and Description
RouteTracker() Initialize a RouteTracker instance with the default "on route" tolerance.
RouteTracker(int onRouteTolerance) Initialize a RouteTracker instance with the provided "on route" tolerance in meters.

Method Summary

Methods

Modifier and Type	Method and Description
com.inrix.sdk.RouteTracker.RoutePoint	findClosestRoutePoint(GeoPoint location, Float locationAccuracy) Get the closest route point from the given location to the end of the route.
Integer	getDistanceRemaining(GeoPoint location, Float locationAccuracy) Get the distance remaining in meters from the given location to the end of the route.
List<Incident>	getIncidentCluster(GeoPoint center, double searchRadiusInMeters) Get incidents cluster within specified radius.
List<Incident>	getIncidentCluster(GeoPoint center, double searchRadiusInMeters, int routeSnappingRadius) Get incidents cluster within specified radius.
SimpleArrayMap<Incident,Double>	getIncidentsWithDistanceFromOrigin() Gets a map of Incident to distance set to the driving distance from origin.
Integer	getTotalRouteDistance() Get the total route distance in meters.
boolean	isOnRoute(GeoPoint location, Float locationAccuracy) Given current location check if this location is along the route.
void	setRoute(Route route) Set the route to track.

Methods inherited from class java.lang.Object

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

Field Detail

ON_ROUTE_TOLERANCE_DEFAULT_METERS

public static final int ON_ROUTE_TOLERANCE_DEFAULT_METERS

Default threshold for considering a user "on route".

See Also:

Constant Field Values

Constructor Detail

RouteTracker

public RouteTracker()

Initialize a RouteTracker instance with the default "on route" tolerance.

See Also:

RouteTracker.ON_ROUTE_TOLERANCE_DEFAULT_METERS

RouteTracker

public RouteTracker(int onRouteTolerance)

Initialize a RouteTracker instance with the provided "on route" tolerance in meters.

Parameters:

onRouteTolerance - The distance in meters that is considered "on route".

Method Detail

setRoute

@WorkerThread
public void setRoute(Route route)

Set the route to track. This work is offloaded onto a separate thread and blocks other calls until completed.

Parameters:

route - The route to track or null to clear the route.

isOnRoute

public boolean isOnRoute(@NonNull
                GeoPoint location,
                Float locationAccuracy)

Given current location check if this location is along the route.

Parameters:

location - The location.

locationAccuracy - The accuracy of the provided location in meters.

Returns:

true if on route, otherwise false.

getIncidentCluster

public List<Incident> getIncidentCluster(@NonNull
                                GeoPoint center,
                                double searchRadiusInMeters)

Get incidents cluster within specified radius.

Parameters:

center - The central to find incidents around.

searchRadiusInMeters - The incident search radius in meters.

Returns:

A list of Incident.

getIncidentCluster

public List<Incident> getIncidentCluster(@NonNull
                                GeoPoint center,
                                double searchRadiusInMeters,
                                int routeSnappingRadius)

Get incidents cluster within specified radius.

Parameters:

center - The central to find incidents around.

searchRadiusInMeters - The incident search radius in meters.

routeSnappingRadius - The max allowed distance between the location from the route.

Returns:

A list of Incident.

getTotalRouteDistance

public Integer getTotalRouteDistance()

Get the total route distance in meters.

Returns:

The total route distance in meters or -1 if no route set.

getDistanceRemaining

public Integer getDistanceRemaining(@NonNull
                           GeoPoint location,
                           Float locationAccuracy)

Get the distance remaining in meters from the given location to the end of the route.

Parameters:

location - The location to get the distance remaining.

locationAccuracy - The accuracy of the provided location in meters.

Returns:

The distance remaining in meters or -1 if input is null, no route set, or not on the route.

findClosestRoutePoint

public com.inrix.sdk.RouteTracker.RoutePoint findClosestRoutePoint(@NonNull
                                                          GeoPoint location,
                                                          Float locationAccuracy)

Get the closest route point from the given location to the end of the route.

Parameters:

location - The location to get the closest point.

locationAccuracy - The accuracy of the provided location in meters.

Returns:

The closest point on the route or null if not on the route.

getIncidentsWithDistanceFromOrigin

public SimpleArrayMap<Incident,Double> getIncidentsWithDistanceFromOrigin()

Gets a map of Incident to distance set to the driving distance from origin.

For congestion, distance calculated using Incident.getHead(), for all other incidents Incident.getLocation().

Returns:

List of Incident and distances from origin.