com.here.android.mpa.routing

Class RouteManager

java.lang.Object

com.here.android.mpa.routing.RouteManager

public class RouteManager
extends java.lang.Object

Represents a manager responsible for calculating a Route from a RoutePlan, with a RouteManager.Listener to monitor calculation progress and trigger appropriate callback methods upon completion.

Before using a RouteManager, an application must set appropriate the HERE developer credentials.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouteManager.Error Represents values describing possible route calculation errors.
static interface	RouteManager.Listener Represents a listener to provide information about RouteManager events.\

Constructor Summary

Constructors

Constructor and Description
RouteManager()

Method Summary

Modifier and Type	Method and Description
RouteManager.Error	calculateRoute(RoutePlan routePlan, RouteManager.Listener listener) Invokes an asynchronous route calculation.
void	cancel() Cancels the current route calculation.
boolean	isBusy() Query whether the RouteManager is currently busy computing a route.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteManager

public RouteManager()

Method Detail

calculateRoute

public RouteManager.Error calculateRoute(RoutePlan routePlan,
                                         RouteManager.Listener listener)

Invokes an asynchronous route calculation. Upon completion of the request, the Listener will be invoked regardless if the request is completed successfully or not.

Parameters:

routePlan - A RoutePlan used to calculate the route

listener - A Listener for the RouteManager

Returns:

The RouteManager.Error error code, one of:

• RouteManager.Error#NONE if route calculation is started
• RouteManager.Error#INVALID_OPERATION if a route calculation could not be started because a calculation is already in progress
• RouteManager.Error#INVALID_PARAMETERS if any of the input parameters is null
• All other errors also indicate route calculation could not be started

cancel

public void cancel()

Cancels the current route calculation. Note that this API is asynchronous as it takes some time cancel all underlying operations. {Please use RouteManager#isBusy() to check when the RouteManager is free again.

isBusy

public boolean isBusy()

Query whether the RouteManager is currently busy computing a route.

Returns:

true if a route calculation is ongoing, false otherwise.