arcgis-maps-kotlin/com.arcgismaps.navigation/ReroutingParameters

ReroutingParameters

Represents the parameters that are used to perform automatic re-routing if off-route while navigating along a route. This class defines how automatic re-routing calculations will be performed if off-route is detected while navigating along a route. To enable re-routing, call the RouteTracker.enableRerouting(ReroutingParameters) method passing in this class as the argument.

Note that re-routing only occurs when the current location is off-route, but on or near the transportation network edges. For example if an off-route state is detected but the tracked location is in a parking lot, away from any transportation network edges, re-routing will not occur, and will occur only once a subsequent tracked location is on or near the transportation network edges.

Since

200.1.0

Constructors

ReroutingParameters

constructor(routeTask: RouteTask, routeParameters: RouteParameters)

Creates a Rerouting parameters. An exception is thrown if the RouteTask or RouteParameters are null.

Properties

networkEdgeGeometries

var networkEdgeGeometries: ArcGISFeatureTable?

A FeatureTable containing the Polyline geometries that the RouteTask's network is based on. During the re-routing the geometries are used to determine if the current location is on or near the navigation network. The re-routing calculation will be skipped if the current location is off the network. The geometry type of the feature table must Polyline. Setting this property is only needed when the RouteTask for the navigation is based on a service. When the RouteTask is based on local data on the device, access to the Polyline geometries is already available to the re-routing algorithm.

routeParameters

val routeParameters: RouteParameters

A RouteParameters object that defines parameters for the rerouting RouteTask. The following RouteParameters properties will be ignored: RouteParameters.setStops(ArcGISFeatureTable, QueryParameters), RouteParameters.findBestSequence, RouteParameters.outputSpatialReference, RouteParameters.preserveFirstStop, RouteParameters.startTime, RouteParameters.returnDirections, RouteParameters.returnStops, and RouteParameters.returnRoutes

routeTask

val routeTask: RouteTask

A RouteTask capable of solving routes on the same network that created the original route. This is usually the same RouteTask that was used to create the route being tracked. The RouteTask will be used for rerouting in background thread.

strategy

var strategy: ReroutingStrategy

A rerouting strategy that determines how new routes are created (to the next waypoint by default).

visitFirstStopOnStart

var visitFirstStopOnStart: Boolean

Whether the first stop must be visited when rerouted (false by default).