10.2.5: AGSRouteTaskParameters Class Reference
10.2.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Pages
AGSRouteTaskParameters Class Reference

Description

Instances of this class represent input parameters for the AGSRouteTask.

The default parameters for an AGSRouteTask can be retrieved by passing AGSRouteTask the retrieveDefaultRouteTaskParameters message and listening to the routeTask:operation:didRetrieveDefaultRouteTaskParameters: delegate method.

Since
1.8
Inheritance diagram for AGSRouteTaskParameters:
<AGSCoding>

Instance Methods

(void) - decodeWithJSON:
 
(NSDictionary *) - encodeToJSON
 
(id) - initWithJSON:
 
(void) - setPointBarriersWithFeatures:
 
(void) - setPointBarriersWithLayerDefinition:
 
(void) - setPolygonBarriersWithFeatures:
 
(void) - setPolygonBarriersWithLayerDefinition:
 
(void) - setPolylineBarriersWithFeatures:
 
(void) - setPolylineBarriersWithLayerDefinition:
 
(void) - setStopsWithFeatures:
 
(void) - setStopsWithLayerDefinition:
 

Class Methods

(id) + routeTaskParameters
 

Properties

NSArray * accumulateAttributeNames
 
NSArray * attributeParameterValues
 
NSString * directionsLanguage
 
AGSNAUnit directionsLengthUnits
 
AGSNADirectionsOutputType directionsOutputType
 
NSString * directionsStyleName
 
NSString * directionsTimeAttributeName
 
BOOL doNotLocateOnRestrictedElements
 
BOOL findBestSequence
 
BOOL ignoreInvalidLocations
 
NSString * impedanceAttributeName
 
double outputGeometryPrecision
 
AGSUnits outputGeometryPrecisionUnits
 
AGSNAOutputLine outputLines
 
AGSSpatialReferenceoutSpatialReference
 
BOOL preserveFirstStop
 
BOOL preserveLastStop
 
NSArray * restrictionAttributeNames
 
BOOL returnDirections
 
BOOL returnPointBarriers
 
BOOL returnPolygonBarriers
 
BOOL returnPolylineBarriers
 
BOOL returnRouteGraphics
 
BOOL returnStopGraphics
 
NSDate * startTime
 
BOOL useHierarchy
 
BOOL useTimeWindows
 
AGSNAUTurn uTurns
 

Method Documentation

- (void) decodeWithJSON: (NSDictionary *)  json
optionalinherited

Decode object from JSON representation.

Parameters
jsonThe JSON representation of the object to be decoded.
Since
1.0
- (NSDictionary *) encodeToJSON
optionalinherited

Encode and return JSON representation for object.

Returns
JSON representation of object.
Since
1.0
- (id) initWithJSON: (NSDictionary *)  json
optionalinherited

Initialize and return object from JSON representation.

Parameters
jsonThe JSON representation of the object to be created.
Returns
Object decoded from JSON representation.
Since
1.0

Reimplemented in AGSWebMapFeatureCollection.

+ (id) routeTaskParameters

Initialize an autoreleased AGSRouteTaskParameters object.

Since
1.8
- (void) setPointBarriersWithFeatures: (NSArray *)  features

Set the point barriers to be used in the solve operation as an array of AGSGraphic objects.

Parameters
featuresThe set of features to be used as point barriers in the analysis.
Since
1.8
- (void) setPointBarriersWithLayerDefinition: (AGSNALayerDefinition *)  layerDefinition

Set the layer information for the point barriers to be used in the solve operation. Not supported by local task.

Parameters
layerDefinitionThe AGSNALayerDefinition containing information about the barriers to be used in the analysis.
Since
1.8
- (void) setPolygonBarriersWithFeatures: (NSArray *)  features

Set the polygon barriers to be used in the solve operation as an array of AGSGraphic objects.

Parameters
featuresThe set of features to be used as polygon barriers in the analysis.
Since
1.8
- (void) setPolygonBarriersWithLayerDefinition: (AGSNALayerDefinition *)  layerDefinition

Set the layer information for the polygon barriers to be used in the solve operation. Not supported by local task.

Parameters
layerDefinitionThe AGSNALayerDefinition containing information about the polygon barriers to be used in the analysis.
Since
1.8
- (void) setPolylineBarriersWithFeatures: (NSArray *)  features

Set the polyline barriers to be used in the solve operation as an array of AGSGraphic objects.

Parameters
featuresThe set of features to be used as polyline barriers in the analysis.
Since
1.8
- (void) setPolylineBarriersWithLayerDefinition: (AGSNALayerDefinition *)  layerDefinition

Set the layer information for the polyline barriers to be used in the solve operation. Not supported by local task.

Parameters
layerDefinitionThe AGSNALayerDefinition containing information about the polyline barriers to be used in the analysis.
Since
1.8
- (void) setStopsWithFeatures: (NSArray *)  features

Set the stops to be used in the solve operation as an array of AGSStopGraphic objects.

Parameters
featuresThe set of features to be used as stops in the analysis.
Since
1.8
- (void) setStopsWithLayerDefinition: (AGSNALayerDefinition *)  layerDefinition

Set the layer information for the stops to be used in the solve operation. Not supported by local task.

Parameters
layerDefinitionThe AGSNALayerDefinition containing information about the stops to be used in the analysis.
Since
1.8

Property Documentation

- (NSArray*) accumulateAttributeNames
readwritenonatomiccopy

This list of network attribute names to be accumulated with the analysis, i.e. which attributes should be returned as part of the response.

The default is as defined by the network analysis layer used in your task. You can specify any attributes names listed in the Services Directory under "Network Dataset -> Network Attributes" as "Usage Type: esriNAUTCost".

Since
1.8
- (NSArray*) attributeParameterValues
readwritenonatomiccopy

An array of NSDictionary objects that describe the parameter values. Properties of this object are: (String) attributeName - Name of the attribute. (String) parameterName - Name of the parameter. (Number or String) value - Parameter value.

Since
1.8
- (NSString*) directionsLanguage
readwritenonatomiccopy

The language used when computing directions. For example, en_US, fr_FR, etc. The default is as defined by the network analysis layer used in your task.

By default, NAServer gets installed with en_US only - it is up to the server administrator to add additional languages.

Since
1.8
- (AGSNAUnit) directionsLengthUnits
readwritenonatomicassign

The length units to use when computing directions. The default is as defined by the network analysis layer used in your task.

Possible types include

  • AGSNAUnitCentimeters
  • AGSNAUnitDays
  • AGSNAUnitDecimalDegrees
  • AGSNAUnitDecimeters
  • AGSNAUnitFeet
  • AGSNAUnitHours
  • AGSNAUnitInches
  • AGSNAUnitKilometers
  • AGSNAUnitMeters
  • AGSNAUnitMiles
  • AGSNAUnitMillimeters
  • AGSNAUnitMinutes
  • AGSNAUnitNauticalMiles
  • AGSNAUnitPoints
  • AGSNAUnitSeconds
  • AGSNAUnitUnknown
  • AGSNAUnitYards
Since
1.8
- (AGSNADirectionsOutputType) directionsOutputType
readwritenonatomicassign

Defines content, verbosity of returned directions. The default is AGSNADirectionsOutputTypeStandard.

Availability:
This feature is only available with services from ArcGIS Server 10.1 or above

Since
2.3
Deprecated:
Deprecated at 10.2. No replacement.
- (NSString*) directionsStyleName
readwritenonatomiccopy

The style to be used when returning the directions. The default is as defined in the network layer.

Since
1.8
- (NSString*) directionsTimeAttributeName
readwritenonatomiccopy

The name of network attribute to use for the drive time when computing directions. The default is as defined by the network analysis layer used in your task.

Since
1.8
Deprecated:
Deprecated at 10.2. No replacement.
- (BOOL) doNotLocateOnRestrictedElements
readwritenonatomicassign

If true, avoids network elements restricted by pointBarriers or due to restrictions specified in restrictionAttributeNames.

Since
1.8
- (BOOL) findBestSequence
readwritenonatomicassign

If true, optimizes the order of the stops in the route while taking into account preserveFirstStop and preserveLastStop, if they are set to true. The default is as defined by the network analysis layer used in your task. Default value is NO.

Since
1.8
- (BOOL) ignoreInvalidLocations
readwritenonatomicassign

In routes where a stop is not located on a network or a stop could not be reached, the results will differ depending on the value of ignoreInvalidLocations. When false, the solve operation will fail if at least one of the stops specified cannot be located or reached. When true, as long as there are at least two valid stops that have been connected by a route, a valid result is returned. If multiple routes are processed in a single request, as long as at least one route is built, a valid result is returned. Default value is NO.

Since
1.8
- (NSString*) impedanceAttributeName
readwritenonatomiccopy

The network attribute name to be used as the impedance attribute in analysis. The default is as defined by the network analysis layer used in your task. You can specify any attributes names listed in the Service Directory under "Network Dataset -> Network Attributes" as "Usage Type: esriNAUTCost". You can also specify a value of "none" to indicate that no network attributes should be used for impedance. If you specify an empty array, it will default to the default of the service.

Since
1.8
- (double) outputGeometryPrecision
readwritenonatomicassign

The precision of the output geometry after generalization. If 0, no generalization of output is performed. If present and positive, it represents the MaximumAllowableOffset parameter. The default value is 5.0 meters.

Since
1.8
- (AGSUnits) outputGeometryPrecisionUnits
readwritenonatomicassign

The units of the output geometry precision. The default value is AGSUnitsMeters.

Possible types include

  • AGSUnitsCentimeters
  • AGSUnitsDecimalDegrees
  • AGSUnitsDecimeters
  • AGSUnitsFeet
  • AGSUnitsInches
  • AGSUnitsKilometers
  • AGSUnitsMeters
  • AGSUnitsMiles
  • AGSUnitsMillimeters
  • AGSUnitsNauticalMiles
  • AGSUnitsPoints
  • AGSUnitsUnknown
  • AGSUnitsYards
Since
1.8
- (AGSNAOutputLine) outputLines
readwritenonatomicassign

The type of lines to be generated in the result.

Known values: see AGSNAOutputLine.

Since
1.8
- (AGSSpatialReference*) outSpatialReference
readwritenonatomicstrong

The spatial reference in which result geometries should be returned. If not specified, the geometries are returned in the spatial reference of the service.

Since
1.8
- (BOOL) preserveFirstStop
readwritenonatomicassign

If true, keeps the first stop fixed in the sequence even when findBestSequence is true. Only applicable if findBestSequence is true. Default is NO.

Since
1.8
- (BOOL) preserveLastStop
readwritenonatomicassign

If true, keeps the last stop fixed in the sequence even when findBestSequence is true. Only applicable if findBestSequence is true. Default is NO.

Since
1.8
- (NSArray*) restrictionAttributeNames
readwritenonatomiccopy

The list of network attribute names to be used as restrictions with the analysis. Possible values are listed in the Service Directory under "Network Dataset -> Network Attributes". You can also specify a value of "none" to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service.

Since
1.8
- (BOOL) returnDirections
readwritenonatomicassign

If true, directions are generated and returned in the directions property of each AGSRouteResult.

Since
1.8
- (BOOL) returnPointBarriers
readwritenonatomicassign

If true, point barriers used in the analysis are returned in the pointBarriers property of AGSRouteTaskResult.

Since
1.8
- (BOOL) returnPolygonBarriers
readwritenonatomicassign

If true, polygon barriers used in the analysis are returned in the pointBarriers property of AGSRouteTaskResult

Since
1.8
- (BOOL) returnPolylineBarriers
readwritenonatomicassign

If true, polyline barriers used in the analysis are returned in the pointBarriers property of AGSRouteTaskResult

Since
1.8
- (BOOL) returnRouteGraphics
readwritenonatomicassign

If true, routes are generated and returned in the route property of each AGSRouteResult.

Since
1.8
- (BOOL) returnStopGraphics
readwritenonatomicassign

If true, stops are returned in the stops property of each AGSRouteResult. Returned stops may contain some additional attributes providing information about the route.

Since
1.8
- (NSDate*) startTime
readwritenonatomicstrong

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

Since
1.8
- (BOOL) useHierarchy
readwritenonatomicassign

If true, the hierarchy attribute for the network should be used in analysis. Default is NO.

Since
1.8
- (BOOL) useTimeWindows
readwritenonatomicassign

If true, time windows should be used in the analysis. Not supported for local route task. Default is NO.

Since
1.8
- (AGSNAUTurn) uTurns
readwritenonatomicassign

Specifies how U-Turns should be handled. U-turns can be allowed everywhere, nowhere , only at dead ends, or only at intersections and dead ends. Allowing U-turns implies the vehicle can turn around at a junction and double back on the same street.

Known values: see AGSNAUTurn.

Since
1.8