Planner/com.benomad.msdk.planner/Planner

Planner

This class defines a Route Planner that allows you to perform route computations through an inter-connected road network.

Constructors

Planner

constructor()

Types

Companion

object Companion

Properties

address

var address: Long

Functions

cancel

fun cancel()

Call this method if you want cancel the current calculation

computeIsochrone

fun computeIsochrone(center: GeoPoint, limit: Int, routeOptions: RouteOptions, listener: ComputeIsochroneListener)

Builds the isochrone polygon around a set of locations situated at a given distance or time of the given center (through the road network).

computeReversedIsochrone

fun computeReversedIsochrone(center: GeoPoint, limit: Int, routeOptions: RouteOptions, listener: ComputeIsochroneListener)

Builds the reversed isochrone polygon around a set of locations situated at a given distance or time of the given center (through the road network).

computeRoute

fun computeRoute(routePlan: RoutePlan, listener: ComputeRouteListener)

Computes a route asynchronously with the given routePlan To find alternative routes, specify the maximum number of alternative routes to compute in the RoutePlan.routeOptions Supported RouteOptim modes: RouteOptim.SHORTEST and RouteOptim.FASTEST is only supported in computeRouteWithChargeStops.

computeRouteWithChargeStops

fun computeRouteWithChargeStops(routePlan: EVRoutePlan, listener: ComputeRouteListener)

Computes a route asynchronously with the given routePlan and optimizes it for the given electric vehicle in EVRoutePlan.routeOptions If the route requires more battery than the current battery level of the vehicle to reach the arrival (defined in VehicleStatus in EVRouteOptions.vehicle), it will be optimized and one or many ChargePoolStop will be added in Route.waypoints. If the EV optimization failed, the unoptimized route will be returned with the detailed error in EVRouteResult.optimChargeResult.

fun computeRouteWithChargeStops(routes: List<Route>, evProfile: EVProfile, status: VehicleStatus, rechargeParams: RechargeParameters, listener: ComputeRouteListener, fastComputation: Boolean = true)

Computes optimized routes asynchronously for an electric vehicle using the given routes

dispose

open override fun dispose()

Call this method if you want to dispose immediately all underlying native resources.

isInitialized

fun isInitialized(): Boolean

Checks that this Planner instance is currently initialized

optimizeTrip

fun optimizeTrip(routePlan: RoutePlan, listener: TripOptimizerListener, searchMode: SearchMode = SearchMode.BEST, tripMode: TripMode = TripMode.TO_FIXED_STOP_TRIP)

Optimizes a RoutePlan's waypoints to have a faster/shorter route.

resume

fun resume()

Call this method if you want resume the current calculation after suspend was called

suspend

fun suspend()

Call this method if you want suspend the current calculation

traceRoute

fun traceRoute(gpsMeasures: List<GPSMeasure>, vehicle: Vehicle, listener: TraceRouteListener, returnMapMatchedPoints: Boolean = false, getAdminPath: Boolean = false, language: Locale? = null)

Performs a Road-Matching (or Map-Matching) process for a specified TranspMode and computes route through matched points. Note : Road-matching consists of correcting uncertainties related to GPS measurements by repositioning a vehicle on most accurate segment of neighbouring roads.