Planner/com.benomad.msdk.planner.remoteplannerproxy/RemotePlannerProxy

RemotePlannerProxy

interface RemotePlannerProxy

Interface for remote planners

Functions

Link copied to clipboard
abstract fun cancel()

Cancel current route computation (rerouting or better route).

Link copied to clipboard
abstract fun checkForBetterRoute(waypoints: List<GeoPoint>, routeOptions: RouteOptions, listener: ComputeRouteListener)

Used by the Navigation to check if a better route is found. The Navigation will handle everything, here we just need to compute a new route.

Link copied to clipboard
abstract fun getNativeAddress(): Long

INTERNAL USE ONLY Get the native address of the remote proxy.

Link copied to clipboard
abstract fun onRerouting(waypoints: Array<Waypoint>?)

This function is called by the Navigation when a rerouting event occurs. The remote planner will have to compute the new Route and return it.

Link copied to clipboard
abstract fun onReroutingError()

If the remote proxy failed to compute the new route, set PlannerErrorCodes.REMOTE_ERROR.

Link copied to clipboard
abstract fun onReroutingFinished(newRoute: Route)

Call this function when the remote planner successfully computed the new route.

Link copied to clipboard
abstract fun onUpdateRouteOptions(routeOptions: RouteOptions?)

This function is called by the Navigation class when a session is started or when a rerouting occurs to notify the Remote Planner with the latest RouteOptions.