OfflineRoutingEngine class abstract

Use this class to calculate a route offline from A to B with a number of waypoints in between.

Route calculation is done asynchronously, and requires map data that is available offline. This can be temporarily cached map data or downloaded offline map data stored in the persisted storage via MapDownloader. Note that when using the cache there is a risk of missing data and this may reduce the overall quality of the route or can result in a RoutingError.noRouteFound error.

The resulting route contains various information such as the polyline, route length in meters, estimated time to traverse along the route and maneuver data, but it does not contain traffic information.

Unlike the RoutingEngine (which requires an online connection), this engine allows to use an unlimited number of waypoints.

As an alternative to this engine, consider to use the RoutingEngine for online route calculations to get fresher traffic, maneuver, route handles and street information, and to use a more elaborate algorithms to calculate the fastest route.

For offline bus routing, enable "OFFLINE_BUS_ROUTING" as feature configuration. For more details, please look at SDKOptions. If this feature is not enabled, the engine may not be able to find bus routes.

Note: EV routing is available when calculating a route using the RoutingOptions, by setting the RoutingOptions.evOptions.

Note: Traffic related information is completely excluded. No historic traffic patterns are taking into consideration for the ETA. Currently blocked or closed roads or roads with traffic incident are not considered offline, i.e. the road may pass through such road. Only seasonal road closures are considered based on the departure time, if given. Traffic information is only considered for online route calculation with the RoutingEngine.

Implemented types

Constructors

OfflineRoutingEngine()
Creates a new instance of this class.
factory
OfflineRoutingEngine.withSdkEngine(SDKNativeEngine sdkEngine)
Creates a new instance of OfflineRoutingEngine.
factory
OfflineRoutingEngine.withSdkEngineAndOptions(SDKNativeEngine sdkEngine, OfflineRoutingEngineOptions options)
Creates a new instance of OfflineRoutingEngine.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
trafficDataProvider TrafficDataProvider?
The traffic data provider that gets internal traffic information considering in routing. If the traffic data provider is null, traffic is not considered in routing. Gets the traffic data provider that provides internal traffic information considering in routing.
getter/setter pair

Methods

calculateBicycleRoute(List<Waypoint> waypoints, BicycleOptions bicycleOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a bicycle route from one point to another, passing through the given waypoints in the given order.
inherited
calculateBusRoute(List<Waypoint> waypoints, BusOptions busOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a bus route from one point to another, passing through the given waypoints in the given order.
inherited
calculateCarRoute(List<Waypoint> waypoints, CarOptions carOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a car route from one point to another, passing through the given waypoints in the given order.
inherited
calculateEVCarRoute(List<Waypoint> waypoints, EVCarOptions evCarOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates an electric car route from one point to another, passing through the given waypoints in the given order.
inherited
calculateEVTruckRoute(List<Waypoint> waypoints, EVTruckOptions evTruckOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates an electic truck route from one point to another, passing through the given waypoints in the given order.
inherited
calculatePedestrianRoute(List<Waypoint> waypoints, PedestrianOptions pedestrianOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a pedestrian route from one point to another, passing through the given waypoints in the given order.
inherited
calculatePrivateBusRoute(List<Waypoint> waypoints, PrivateBusOptions privateBusOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a private bus route from one point to another, passing through the given waypoints in the given order.
inherited
calculateRouteWithRoutingOptions(List<Waypoint> waypoints, RoutingOptions options, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a route from one point to another, passing through the given waypoints in the given order.
inherited
calculateScooterRoute(List<Waypoint> waypoints, ScooterOptions scooterOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a scooter route from one point to another, passing through the given waypoints in the given order.
inherited
calculateTaxiRoute(List<Waypoint> waypoints, TaxiOptions taxiOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a taxi route from one point to another, passing through the given waypoints in the given order.
inherited
calculateTruckRoute(List<Waypoint> waypoints, TruckOptions truckOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a truck route from one point to another, passing through the given waypoints in the given order.
inherited
importFromHandleWithRoutingOptions(RouteHandle routeHandle, RoutingOptions options, CalculateRouteCallback callback) TaskHandle
Asynchronously recreates a route from the RouteHandle provided, i.e.
importRouteFromHandle(RouteHandle routeHandle, RefreshRouteOptions refreshRouteOptions, CalculateRouteCallback callback) TaskHandle
Asynchronously recreates a route from the RouteHandle provided, i.e.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
returnToRouteWithTraveledDistance(Route route, Waypoint startingPoint, int lastTraveledSectionIndex, int traveledDistanceOnLastSectionInMeters, CalculateRouteCallback callback) TaskHandle
Asynchronously calculates a new route that leads back to the original route.
inherited
setInternalOption(String key, String value) → void
This method sets internal options that controls offline route calculation behavior.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited