public class RouteManager extends Object
Modifier and Type | Class and Description |
---|---|
static interface |
RouteManager.IBestTimeToLeaveListener
Response listener for information on the best time to leave on a route.
|
static interface |
RouteManager.IRouteResponseListener
Response listener for requesting routes.
|
static interface |
RouteManager.ITravelTimeResponseListener
Response listener for travel time information.
|
static interface |
RouteManager.IUpdatedRouteListener
Response listener for updated route information.
|
static class |
RouteManager.RequestRouteOptions
Contains options that specify what route information to retrieve.
|
static class |
RouteManager.RequestTime
Enumeration that defines the time associated with the RouteRequest.
|
static class |
RouteManager.RouteManagerException
An exception that is thrown when there is an error with an
RouteManager operation. |
static class |
RouteManager.RouteType
Enumeration for route types supported by Inrix Connected Services platform.
|
static class |
RouteManager.TravelTimeOptions
Contains options that specify what travel time information to retrieve.
|
static class |
RouteManager.UpdatedRouteOptions
Contains options that specify what information to get when requesting updated route info.
|
Modifier and Type | Field and Description |
---|---|
static int |
MAX_HEADING_VALUE
The maximum allowed heading value.
|
static int |
MAXIMUM_TRAVEL_TIME_COUNT
Maximum number of travel times.
|
static long |
MAXIMUM_TRAVEL_TIME_INTERVAL_MS
Maximum travel time interval (in milliseconds).
|
static int |
MIN_HEADING_VALUE
The minimum allowed heading value.
|
static int |
MINIMUM_TRAVEL_TIME_COUNT
Minimum number of travel times.
|
static long |
MINIMUM_TRAVEL_TIME_INTERVAL_MS
Minimum travel time interval (in milliseconds).
|
static int |
ROUTE_CRITERIA_AVOID_FERRIES
Constant to specify that the route find avoid ferries.
|
static int |
ROUTE_CRITERIA_AVOID_HIGHWAYS
Constant to specify that the route find avoid highways.
|
static int |
ROUTE_CRITERIA_AVOID_TOLL_ROADS
Constant to specify that the route find avoid toll roads.
|
static int |
ROUTE_CRITERIA_AVOID_VIGNETTE
Constant to specify that the route find avoid vignettes.
|
static int |
ROUTE_CRITERIA_NO_RESTRICTIONS
No restrictions for the route find request.
|
static int |
ROUTE_OUTPUT_FIELD_ALL
Return all fields.
|
static int |
ROUTE_OUTPUT_FIELD_BOUNDING_BOX
Return a geographical bounding box of the entire route.
|
static int |
ROUTE_OUTPUT_FIELD_INCIDENTS
Return a list of any incidents occurring on the route.
|
static int |
ROUTE_OUTPUT_FIELD_POINTS
Return a list of points along the route, returned in latitude/longitude
pairs.
|
static int |
ROUTE_OUTPUT_FIELD_SUMMARY
Return the route summary, which is a high level summary of the major roads on the
route.
|
static int |
ROUTE_OUTPUT_FIELD_WAYPOINTS
Return the waypoints used to calculate the route.
|
Modifier and Type | Method and Description |
---|---|
ICancellable |
getBestTimeToLeave(RouteManager.TravelTimeOptions options,
RouteManager.IBestTimeToLeaveListener listener)
Find the best time to leave based on the specified options.
|
RoutesConfig |
getConfiguration()
Gets the configuration for
RouteManager . |
ICancellable |
getUpdatedRouteInfo(RouteManager.UpdatedRouteOptions options,
RouteManager.IUpdatedRouteListener listener)
Get updated route information with the supplied options.
|
ICancellable |
requestRoutes(RouteManager.RequestRouteOptions options,
RouteManager.IRouteResponseListener listener)
Takes a set of waypoints and calculates one or more routes from the first waypoint to the last waypoint, passing through other optional waypoints in turn.
|
ICancellable |
requestTravelTimes(RouteManager.TravelTimeOptions options,
RouteManager.ITravelTimeResponseListener listener)
Request travel times for a route.
|
public static final int ROUTE_OUTPUT_FIELD_ALL
public static final int ROUTE_OUTPUT_FIELD_SUMMARY
public static final int ROUTE_OUTPUT_FIELD_WAYPOINTS
public static final int ROUTE_OUTPUT_FIELD_BOUNDING_BOX
public static final int ROUTE_OUTPUT_FIELD_POINTS
public static final int ROUTE_OUTPUT_FIELD_INCIDENTS
public static final int ROUTE_CRITERIA_NO_RESTRICTIONS
public static final int ROUTE_CRITERIA_AVOID_TOLL_ROADS
public static final int ROUTE_CRITERIA_AVOID_HIGHWAYS
public static final int ROUTE_CRITERIA_AVOID_FERRIES
public static final int ROUTE_CRITERIA_AVOID_VIGNETTE
public static final int MIN_HEADING_VALUE
public static final int MAX_HEADING_VALUE
public static final int MINIMUM_TRAVEL_TIME_COUNT
public static final int MAXIMUM_TRAVEL_TIME_COUNT
public static final long MINIMUM_TRAVEL_TIME_INTERVAL_MS
public static final long MAXIMUM_TRAVEL_TIME_INTERVAL_MS
public RoutesConfig getConfiguration()
RouteManager
.RoutesConfig
.public ICancellable requestTravelTimes(RouteManager.TravelTimeOptions options, RouteManager.ITravelTimeResponseListener listener)
options
- Contains the route ID, the travel time count, and the travel time interval
as mandatory parameters, and the departure time and arrival
time as optional parameters.listener
- The listener that will receive the response.ICancellable
so that the request can be cancelled.RouteManager.RouteManagerException
- when either options
or listener
is null
.public ICancellable getBestTimeToLeave(RouteManager.TravelTimeOptions options, RouteManager.IBestTimeToLeaveListener listener)
options
- Information about what travel times to calculate.listener
- The listener that will receive the response.ICancellable
so that the request can be cancelled.RouteManager.RouteManagerException
- when either options
or listener
is null
.public ICancellable requestRoutes(RouteManager.RequestRouteOptions options, RouteManager.IRouteResponseListener listener)
options
- Information on what routes to return.listener
- The listener that will receive the response.ICancellable
so that the request can be cancelled.RouteManager.RouteManagerException
- when either options or listener is null.public ICancellable getUpdatedRouteInfo(RouteManager.UpdatedRouteOptions options, RouteManager.IUpdatedRouteListener listener)
options
- Information on what should be return.listener
- The listener that will receive the response.ICancellable
so that the request can be cancelled.RouteManager.RouteManagerException
- when either options or listener is null.Copyright © 2013-2018 INRIX, Inc. All Rights Reserved.