Planner/com.benomad.msdk.planner/Planner/traceRoute

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.

Parameters

gpsMeasures

a list of GPSMeasure that must have at least 2 entries.

vehicle

Vehicle that must have a defined Vehicle.vehicleModel with a defined Profile

returnMapMatchedPoints

Set this flag to true if you want to get the list of the map-matched positions.

getAdminPath

Set this flag to true if you want to retrieve the complete hierarchical paths (left and right) of selected roads (See GeoMapMatchedPoint.getLeftGeoPath and GeoMapMatchedPoint.getRightGeoPath).

Default value is false.

language

Preferential language for object's names. Default value is null. (default language will be used)

listener

TraceRouteListener for getting computation's progress and result with the list of computed map-matched points if returnMapMatchedPoints is set to true.

Throws

when caught ComputeRouteListener.onComputeError is called with a Error.code corresponding to the PlannerException.code and a Error.detailedMessage corresponding to the PlannerException.message