com.inrix.sdk

Class RouteManager.UpdatedRouteOptions

java.lang.Object

com.inrix.sdk.RouteManager.UpdatedRouteOptions

All Implemented Interfaces:

Cloneable

Enclosing class:

RouteManager

public static final class RouteManager.UpdatedRouteOptions
extends Object
implements Cloneable

Contains options that specify what information to get when requesting updated route info.

See Also:

RouteManager.getUpdatedRouteInfo(UpdatedRouteOptions, IUpdatedRouteListener)

Constructor Summary

Constructors

Constructor and Description
UpdatedRouteOptions(Route route) Initializes a new instance of the RouteManager.UpdatedRouteOptions class.
UpdatedRouteOptions(Route route, GeoPoint currentLocation) Initializes a new instance of the RouteManager.UpdatedRouteOptions class.
UpdatedRouteOptions(Route route, GeoPoint currentLocation, boolean returnBetterRoute) Initializes a new instance of the RouteManager.UpdatedRouteOptions class.

Method Summary

Methods

Modifier and Type	Method and Description
RouteManager.UpdatedRouteOptions	clone()
RouteManager.UpdatedRouteOptions	setCollapseManeuvers(boolean collapseManeuvers) Set the flag to collapse the maneuvers of this route response.
RouteManager.UpdatedRouteOptions	setCurrentLocation(GeoPoint point) Sets the current location along the route.
void	setLocale(Locale locale) Set the locale of the Route.
T	setOutputFields(int outputFields) Sets what route information should be returned.
RouteManager.UpdatedRouteOptions	setReturnBetterRoute(boolean returnBetterRoute) Set whether or not to return a better route from the current location if available.
RouteManager.UpdatedRouteOptions	setRoute(Route route) Sets the route to request updated information for.
T	setRouteRequestTime(RouteManager.RequestTime type, Date time) Set the request time for the current route request.
T	setRouteType(RouteManager.RouteType routeType) Set the RouteManager.RouteType for this request.
T	setSpeedBucketsEnabled(boolean enableSpeedBuckets) Enable or disable speed buckets in the request.
T	setTolerance(int tolerance) Sets the tolerance, which affects the number of latitude/longitude points returned.
T	setUnits(UserPreferences.Unit units) Sets units explicitly for this route request.
T	setUseTraffic(boolean useTraffic) Set the flag to use or not use traffic while finding a route.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdatedRouteOptions

public UpdatedRouteOptions(Route route)

Initializes a new instance of the RouteManager.UpdatedRouteOptions class.

Parameters:

route - The route to retrieve updated information for.

UpdatedRouteOptions

public UpdatedRouteOptions(Route route,
                   GeoPoint currentLocation)

Initializes a new instance of the RouteManager.UpdatedRouteOptions class.

Parameters:

route - The route to retrieve updated information for.

currentLocation - The current location along the route. See RouteManager.UpdatedRouteOptions.setCurrentLocation(com.inrix.sdk.model.GeoPoint).

UpdatedRouteOptions

public UpdatedRouteOptions(Route route,
                   GeoPoint currentLocation,
                   boolean returnBetterRoute)

Initializes a new instance of the RouteManager.UpdatedRouteOptions class.

Parameters:

route - The route to retrieve updated information for.

currentLocation - The current location along the route. See RouteManager.UpdatedRouteOptions.setCurrentLocation(com.inrix.sdk.model.GeoPoint).

returnBetterRoute - A flag for returning a better route if available. See RouteManager.UpdatedRouteOptions.setReturnBetterRoute(boolean).

Method Detail

setRoute

public RouteManager.UpdatedRouteOptions setRoute(Route route)

Sets the route to request updated information for.

Parameters:

route - The route.

Returns:

This instance of the RouteManager.UpdatedRouteOptions class.

Throws:

RouteManager.RouteManagerException - when route is null, doesn't contain any points, or only contains only one point.

setCurrentLocation

public RouteManager.UpdatedRouteOptions setCurrentLocation(GeoPoint point)

Sets the current location along the route.

Specifying this parameter will return only information from this point to the end of the route, with the exception of Route.getPoints(), Route.getSpeedBuckets(), and Route.getBoundingBox().

Parameters:

point - The current location.

Returns:

This instance of the RouteManager.UpdatedRouteOptions class.

Throws:

RouteManager.RouteManagerException - when the point is invalid.

setReturnBetterRoute

public RouteManager.UpdatedRouteOptions setReturnBetterRoute(boolean returnBetterRoute)

Set whether or not to return a better route from the current location if available. Note that this will be ignored if the current location has not been set.

Parameters:

returnBetterRoute - True to get a better route if available, false otherwise.

Returns:

This instance of the RouteManager.UpdatedRouteOptions class.

See Also:

RouteManager.UpdatedRouteOptions.setCurrentLocation(com.inrix.sdk.model.GeoPoint)

setCollapseManeuvers

public RouteManager.UpdatedRouteOptions setCollapseManeuvers(boolean collapseManeuvers)

Set the flag to collapse the maneuvers of this route response.

Parameters:

collapseManeuvers - If true, minor maneuvers are collapsed into one. If false, no maneuvers are collapsed.

Returns:

This instance of the RouteManager.UpdatedRouteOptions class.

toString

public String toString()

Overrides:

toString in class Object

clone

public RouteManager.UpdatedRouteOptions clone()

Overrides:

clone in class Object

setTolerance

public T setTolerance(int tolerance)

Sets the tolerance, which affects the number of latitude/longitude points returned.

The tolerance value should be greater than or equal to 0 and is specified in yards for English units and meters for metric units. The default is 0, which means exact (no inaccuracy is tolerated), and results in all possible points being returned. Higher values will reduce the number of points by eliminating points whose distance from each other is less than the specified tolerance. Based on the level of zoom used to draw the map, you can save bandwidth by reducing the size of the return payload. For example, if the map is zoomed to a 300-mile level, you may want to return fewer data points.

Parameters:

tolerance - The tolerance value in yards or meters, depending on the units set in the user preferences.

Returns:

This instance of the class.

Throws:

RouteManager.RouteManagerException - when tolerance is less than zero.

setSpeedBucketsEnabled

public T setSpeedBucketsEnabled(boolean enableSpeedBuckets)

Enable or disable speed buckets in the request.

Parameters:

enableSpeedBuckets - true to enabled speed buckets, false otherwise

Returns:

This instance of the class.

setOutputFields

public T setOutputFields(int outputFields)

Sets what route information should be returned.

Fields can be combined. For instance, to return both route summary and waypoints, use RouteManager.ROUTE_OUTPUT_FIELD_SUMMARY | RouteManager.ROUTE_OUTPUT_FIELD_WAYPOINTS.

Parameters:

outputFields - Fields to return for route information.

Returns:

This instance of the class.

Throws:

RouteManager.RouteManagerException - when outputFields is invalid.

setUnits

public T setUnits(UserPreferences.Unit units)

Sets units explicitly for this route request. These units override the units set in the user preferences.

Parameters:

units - The units of this request.

Returns:

This instance of the class.

Throws:

RouteManager.RouteManagerException - Thrown when units is null.

setRouteRequestTime

public T setRouteRequestTime(RouteManager.RequestTime type,
                    Date time)

Set the request time for the current route request.

Parameters:

type - An instance of enum RouteManager.RequestTime which denotes if the time is RouteManager.RequestTime.DEPARTURE_TIME or RouteManager.RequestTime.DEPARTURE_TIME. Note:- if the type is RouteManager.RequestTime.DEPARTURE_TIME and passed in a time in the past, then the requests get time stamped with the current time stamp.

time - The time associated with the current route request.

Returns:

This instance of the class.

setUseTraffic

public T setUseTraffic(boolean useTraffic)

Set the flag to use or not use traffic while finding a route.

Parameters:

useTraffic - - if true traffic is considered while calculating the route - if false traffic is not considered.

Returns:

This instance of the class.

setRouteType

public T setRouteType(RouteManager.RouteType routeType)

Set the RouteManager.RouteType for this request.

Parameters:

routeType - - Fastest or shortest RouteManager.RouteType.

Returns:

This instance of the class.

Throws:

RouteManager.RouteManagerException - Thrown when routeType is null.

setLocale

public void setLocale(Locale locale)

Set the locale of the Route.

Parameters:

locale - The locale or null to use the default.