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
◆ 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
Clear any stops that may have been set earlier
- Since
- 100
◆ 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:
Set point barriers to avoid in the result route
- Parameters
-
- Since
- 100
◆ setPointBarriersWithFeatureTable: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:
Set polygon barriers to avoid in the result route
- Parameters
-
- Since
- 100
◆ setPolygonBarriersWithFeatureTable: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:
Set polyline barriers to avoid in the result route
- Parameters
-
- Since
- 100
◆ setPolylineBarriersWithFeatureTable: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:
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
◆ 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
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
The style to use for providing directions.
- Since
- 100
◆ findBestSequence
- (BOOL) findBestSequence |
|
readwritenonatomicassign |
◆ outputSpatialReference
◆ preserveFirstStop
- (BOOL) preserveFirstStop |
|
readwritenonatomicassign |
◆ preserveLastStop
- (BOOL) preserveLastStop |
|
readwritenonatomicassign |
◆ returnDirections
- (BOOL) returnDirections |
|
readwritenonatomicassign |
◆ returnPointBarriers
- (BOOL) returnPointBarriers |
|
readwritenonatomicassign |
◆ returnPolygonBarriers
- (BOOL) returnPolygonBarriers |
|
readwritenonatomicassign |
◆ returnPolylineBarriers
- (BOOL) returnPolylineBarriers |
|
readwritenonatomicassign |
◆ returnRoutes
◆ returnStops
Specifies whether to return stops along each route in the result AGSRoute::stops
- Since
- 100
◆ routeShapeType
◆ startTime
The time the route begins. If not specified, defaults to the time the task is executed.
- Since
- 100
◆ travelMode
Specifies the travel mode to use when computing the routes
- Since
- 100