ArcGIS Runtime SDK for iOS: AGSReroutingParameters Class Reference
ArcGIS Runtime SDK for iOS  100.15
AGSReroutingParameters Class Reference

Description

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 enableReroutingWithParameters:completion: (AGSRouteTracker) 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
100.11
Inheritance diagram for AGSReroutingParameters:
AGSObject

Instance Methods

(nullable instancetype) - initWithRouteTask:routeParameters:
 

Class Methods

(nullable instancetype) + reroutingParametersWithRouteTask:routeParameters:
 

Properties

AGSArcGISFeatureTablenetworkEdgeGeometries
 
AGSRouteParametersrouteParameters
 
AGSRouteTaskrouteTask
 
AGSReroutingStrategy strategy
 
BOOL visitFirstStopOnStart
 

Method Documentation

◆ initWithRouteTask:routeParameters:

- (nullable instancetype) initWithRouteTask: (AGSRouteTask *)  routeTask
routeParameters: (AGSRouteParameters *)  routeParameters 

Creates a rerouting parameters object.

Returns nil if the AGSRouteTask or AGSRouteParameters are nil.

Parameters
routeTaskAn AGSRouteTask capable of solving routes on the same network used by the original route.
routeParametersCreates a re-routing parameters object based on an AGSRouteTask and AGSRouteParameters.
See also
AGSRouteResult
Since
100.11

◆ reroutingParametersWithRouteTask:routeParameters:

+ (nullable instancetype) reroutingParametersWithRouteTask: (AGSRouteTask *)  routeTask
routeParameters: (AGSRouteParameters *)  routeParameters 

Creates a rerouting parameters object.

Returns nil if the AGSRouteTask or AGSRouteParameters are nil.

Parameters
routeTaskAn AGSRouteTask capable of solving routes on the same network used by the original route.
routeParametersCreates a re-routing parameters object based on an AGSRouteTask and AGSRouteParameters.
See also
AGSRouteResult
Since
100.11

Property Documentation

◆ networkEdgeGeometries

- (AGSArcGISFeatureTable*) networkEdgeGeometries
readwritenonatomicstrong

An AGSFeatureTable containing the AGSPolyline geometries that the AGSRouteTask'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 AGSPolyline.

Setting this property is only needed when the AGSRouteTask for the navigation is based on a service. When the AGSRouteTask is based on local data on the device, access to the AGSPolyline geometries is already available to the re-routing algorithm via the Runtime.

The AGSFeatureTable can be the original network source data or one created specifically for checking if located on an edge.

If there are multiple sources, the geometries should be merged into a single table.

Only the geometries are needed in the AGSFeatureTable, not the attributes.

Online feature service should support pagination. To improve performance, the online feature service should have a maxRecordCount >= 2000 (this decreases the count of online queries).

Since
100.11

◆ routeParameters

◆ routeTask

- (AGSRouteTask*) routeTask
readnonatomicstrong

An AGSRouteTask capable of solving routes on the same network that created the original route.

This is usually the same AGSRouteTask that was used to create the route being tracked. The AGSRouteTask will be used for rerouting in background thread.

Since
100.11

◆ strategy

- (AGSReroutingStrategy) strategy
readwritenonatomicassign

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

Since
100.11

◆ visitFirstStopOnStart

- (BOOL) visitFirstStopOnStart
readwritenonatomicassign

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

Since
100.11