TrafficRouter
Interface for finding a route based on traffic jam data.
ru.dgis.sdk.NativeObjectTrafficRouter(context: Context, routerType: RouterType = RouterType.HYBRID)
fun findRoute(
startPoint: RouteSearchPoint,
finishPoint: RouteSearchPoint,
routeSearchOptions: RouteSearchOptions,
intermediatePoints: List<RouteSearchPoint> = listOf()
): Future<List<TrafficRoute>>
Searches for a route with the given parameters.
startPointRouteSearchPointStarting point of the route.
finishPointRouteSearchPointFinish point of the route.
routeSearchOptionsRouteSearchOptionsRoute search options.
intermediatePointsList<RouteSearchPoint>Intermediate points to pass in the same order in which the points are given in the vector.
Future<List<TrafficRoute>>Future with a set of found routes, or throw a NativeException on failure.
An empty route set is a valid result, meaning that a route matching the specified search criteria cannot be found.
When searching for routes for freight transport, it is possible to return routes passing through the access zones for which passes were not provided, if it was not possible to route only through the access zones for which the passes were provided. To check if the list of passes is sufficient to pass a route, use the route_matches_truck_pass_zone_passes function.
fun requestRoute(request: ByteArray, serverEndpoint: String): Future<List<TrafficRoute>>
Searches for a route using previously serialized parameters.
requestByteArraySerialized request parameters.
serverEndpointStringType of route specified in the request endpoint: bicycle, carrouting, pedestrian, truck.
Future<List<TrafficRoute>>Future with a set of found routes or throwing a NativeException on failure.
Not suitable for finding public transport routes.
If it is not possible to find truck routes, it does not try to find car routes without taking into account truck restrictions.
fun findBriefRouteInfos(searchPoints: List<BriefRouteInfoSearchPoints>, routeSearchOptions: RouteSearchOptions): Future<List<BriefRouteInfo?>>
Searches for basic route information for a matching set of search points.
searchPointsList<BriefRouteInfoSearchPoints>Set of points for finding basic information about the route.
routeSearchOptionsRouteSearchOptionsRoute search options.
Future<List<BriefRouteInfo?>>Future with basic information about the set of routes corresponding to the set of search points, or throwing a NativeException on failure.
If the basic information for any of the pairs of points is not found, the element at the corresponding index in the returned result is null.
val truckPassZonePassesReturns a list of all supported passes that allow truck traffic within the pass zones.