AGSRouteParameters Class Reference

Description

Input parameters for AGSRouteTask.

Instances of this class represent input parameters for computing routes using AGSRouteTask.

Note

Consider using the convenience method defaultRouteParametersWithCompletion: (AGSRouteTask) to get an instance of this class that is initialized with smart default values based on the task's metadata (routeTaskInfo (AGSRouteTask))

Since

100

Inheritance diagram for AGSRouteParameters:

Instance Methods
(void)	- clearPointBarriers
(void)	- clearPolygonBarriers
(void)	- clearPolylineBarriers
(void)	- clearStops
(instancetype)	- init
(NSString *)	- searchWhereClauseForSourceName:
(void)	- setPointBarriers:
(void)	- setPointBarriersWithFeatureTable:queryParameters:
(void)	- setPolygonBarriers:
(void)	- setPolygonBarriersWithFeatureTable:queryParameters:
(void)	- setPolylineBarriers:
(void)	- setPolylineBarriersWithFeatureTable:queryParameters:
(void)	- setSearchWhereClause:forSourceName:
(void)	- setStops:
(void)	- setStopsWithFeatureTable:queryParameters:

Class Methods
(instancetype)	+ routeParameters

Properties
NSArray< NSString * > *	accumulateAttributeNames
AGSUnitSystem	directionsDistanceUnits
NSString *	directionsLanguage
AGSDirectionsStyle	directionsStyle
BOOL	findBestSequence
AGSSpatialReference *	outputSpatialReference
BOOL	preserveFirstStop
BOOL	preserveLastStop
BOOL	returnDirections
BOOL	returnPointBarriers
BOOL	returnPolygonBarriers
BOOL	returnPolylineBarriers
BOOL	returnRoutes
BOOL	returnStops
AGSRouteShapeType	routeShapeType
NSDate *	startTime
AGSTravelMode *	travelMode

Method Documentation

clearPointBarriers

- (void) clearPointBarriers

Clear any point barriers that may have been set earlier

Since

100

clearPolygonBarriers

- (void) clearPolygonBarriers

Clear any polygon barriers that may have been set earlier

Since

100

clearPolylineBarriers

- (void) clearPolylineBarriers

Clear any polyline barriers that may have been set earlier

Since

100

clearStops

- (void) clearStops

Clear any stops that may have been set earlier

Since

100

init

- (instancetype) init

routeParameters

+ (instancetype) routeParameters

searchWhereClauseForSourceName:

- (NSString*) searchWhereClauseForSourceName:

(NSString *)

sourceName

Returns the filter used to specify which network elements stops can be located on. For example, if you have a network which has multiple sources such as streets, bus lines, air lines, etc., you could specify that stops be located only on certain sources.

Parameters

sourceName

of the network element the filter applies to

Returns

The filter specifiying which network elements can stops be located on

Since

100

setPointBarriers:

- (void) setPointBarriers:

(NSArray< AGSPointBarrier * > *)

pointBarriers

Set point barriers to avoid in the result route

Parameters

pointBarriers

an array of AGSPointBarrier to avoid.

Since

100

setPointBarriersWithFeatureTable:queryParameters:

- (void) setPointBarriersWithFeatureTable:		(AGSArcGISFeatureTable *)	featureTable
queryParameters:		(AGSQueryParameters *)	queryParameters

Set point barriers to avoid in the result route

Parameters

featureTable	containing point features to use as barriers
queryParameters	to filter which features to use

Since

100

setPolygonBarriers:

- (void) setPolygonBarriers:

(NSArray< AGSPolygonBarrier * > *)

polygonBarriers

Set polygon barriers to avoid in the result route

Parameters

polygonBarriers

an array of AGSPolygonBarrier to avoid.

Since

100

setPolygonBarriersWithFeatureTable:queryParameters:

- (void) setPolygonBarriersWithFeatureTable:		(AGSArcGISFeatureTable *)	featureTable
queryParameters:		(AGSQueryParameters *)	queryParameters

Set polygon barriers to avoid in the result route

Parameters

featureTable	containing polygon features to use as barriers
queryParameters	to filter which features to use

Since

100

setPolylineBarriers:

- (void) setPolylineBarriers:

(NSArray< AGSPolylineBarrier * > *)

lineBarriers

Set polyline barriers to avoid in the result route

Parameters

lineBarriers

an array of AGSPolylineBarrier to avoid.

Since

100

setPolylineBarriersWithFeatureTable:queryParameters:

- (void) setPolylineBarriersWithFeatureTable:		(AGSArcGISFeatureTable *)	featureTable
queryParameters:		(AGSQueryParameters *)	queryParameters

Set polyline barriers to avoid in the result route

Parameters

featureTable	containing polyline features to use as barriers
queryParameters	to filter which features to use

Since

100

setSearchWhereClause:forSourceName:

- (void) setSearchWhereClause:		(NSString *)	searchWhereClause
forSourceName:		(NSString *)	sourceName

Specifies which network elements stops can be located on. For example, if you have a network which has multiple sources such as streets, bus lines, air lines, etc., you could specify that stops be located only on certain sources.

Parameters

searchWhereClause	The filter specifiying which network elements can stops be located on
sourceName	the network elements the filter applies to

Since

100

setStops:

- (void) setStops:

(NSArray< AGSStop * > *)

stops

Set the stops to visit in the result route

Parameters

stops

an array of AGSStop to visit in the route

Since

100

setStopsWithFeatureTable:queryParameters:

- (void) setStopsWithFeatureTable:		(AGSArcGISFeatureTable *)	featureTable
queryParameters:		(AGSQueryParameters *)	queryParameters

Set the stops to visit in the result route

Parameters

featureTable	containing point features to use as stops
queryParameters	to filter which features to use

Since

100

Property Documentation

accumulateAttributeNames

- (NSArray<NSString*>*) accumulateAttributeNames

readwritenonatomiccopy

A list of network attributes to be accumulated and returned as part of the route. You might want to perform the analysis using a distance-based impedance attribute and accumulate a time-based cost attribute. Available attributes are specified by AGSRouteTaskInfo::accumulateAttributeNames. These attributes represent costs such as Drive Time, Distance, Toll expenses, etc.

Since

100

directionsDistanceUnits

- (AGSUnitSystem) directionsDistanceUnits

readwritenonatomicassign

The linear units to use while providing distances for turn-by-turn directions.

Since

100

directionsLanguage

- (NSString*) directionsLanguage

readwritenonatomiccopy

The language used when computing directions. For example, en, fr, pt-BR, zh-Hans, etc. The list of languages supported is available in AGSRouteTaskInfo::supportedLanguages

Since

100

directionsStyle

- (AGSDirectionsStyle) directionsStyle

readwritenonatomicassign

The style to use for providing directions.

Since

100

findBestSequence

- (BOOL) findBestSequence

readwritenonatomicassign

Specifies whether or not to optimize the order of the stops in the route.

Since

100

See also

preserveFirstStop

preserveLastStop

outputSpatialReference

- (AGSSpatialReference*) outputSpatialReference

readwritenonatomicstrong

The spatial reference in which the result geometries should be returned. If nil, the results will be returned in the spatial reference specified by AGSRouteTaskInfo::outputSpatialReference.

Since

100

preserveFirstStop

- (BOOL) preserveFirstStop

readwritenonatomicassign

If YES, keeps the first stop fixed in the sequence even when findBestSequence is enabled. Only applicable if findBestSequence is enabled.

Since

100

preserveLastStop

- (BOOL) preserveLastStop

readwritenonatomicassign

If YES, keeps the last stop fixed in the sequence even when findBestSequence is enabled. Only applicable if findBestSequence is enabled.

Since

100

returnDirections

- (BOOL) returnDirections

readwritenonatomicassign

Specifies whether to return turn-by-turn directions in the result AGSRoute::directionManeuvers

Since

100

returnPointBarriers

- (BOOL) returnPointBarriers

readwritenonatomicassign

Specifies whether to return the point barriers used while computing the route in the result AGSRouteResult::pointBarriers

Since

100

returnPolygonBarriers

- (BOOL) returnPolygonBarriers

readwritenonatomicassign

Specifies whether to return the polygon barriers used while computing the route in the result AGSRouteResult::polygonBarriers

Since

100

returnPolylineBarriers

- (BOOL) returnPolylineBarriers

readwritenonatomicassign

Specifies whether to return the polyline barriers used while computing the route in the result AGSRouteResult::polylineBarriers

Since

100

returnRoutes

- (BOOL) returnRoutes

readwritenonatomicassign

Specifies whether to return routes in the result AGSRouteResult::routes

Since

100

returnStops

- (BOOL) returnStops

readwritenonatomicassign

Specifies whether to return stops along each route in the result AGSRoute::stops

Since

100

routeShapeType

- (AGSRouteShapeType) routeShapeType

readwritenonatomicassign

Specifies the type of route geometry to return in the result AGSRoute::routeGeometry

Since

100

startTime

- (NSDate*) startTime

readwritenonatomicstrong

The time the route begins. If not specified, defaults to the time the task is executed.

Since

100

travelMode

- (AGSTravelMode*) travelMode

readwritenonatomicstrong

Specifies the travel mode to use when computing the routes

Since

100