AGSServiceAreaTaskParameters Class Reference
Description
Instances of this class represent parameters to be used as input to the AGSServiceAreaTask.
The default parameters for an AGSServiceAreaTask can be retrieved by passing AGSServiceAreaTask the retrieveDefaultServiceAreaTaskParameters message and listening to the serviceAreaTask:operation:didRetrieveDefaultServiceAreaTaskParameters: delegate method.
- Since:
- 1.8
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
| + (id) serviceAreaTaskParameters |
Initialize an autoreleased AGSServiceAreaTaskParameters object.
- Since:
- 1.8
| - (void) setFacilitiesWithFeatures: | (NSArray *) | features |
Set the facilities to be used in the service area operation.
- Parameters:
-
features An array of AGSGraphicobjects representing features to be used as facilities in the analysis.
- Since:
- 1.8
| - (void) setFacilitiesWithLayerDefinition: | (AGSNALayerDefinition *) | layerDefinition |
Set the layer information for the facilities to be used in the service area operation.
- Parameters:
-
layerDefinition The AGSNALayerDefinitioncontaining information about the facilities to be used in the analysis.
- Since:
- 1.8
| - (void) setPointBarriersWithFeatures: | (NSArray *) | features |
Set the point barriers to be used in the service area operation.
- Parameters:
-
features An array of AGSGraphicobjects representing 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 service area operation.
- Parameters:
-
layerDefinition The AGSNALayerDefinitioncontaining 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 service operation.
- Parameters:
-
features An array of AGSGraphicobjects representing 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 service area operation.
- Parameters:
-
layerDefinition The AGSNALayerDefinitioncontaining 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 service area operation.
- Parameters:
-
features An array of AGSGraphicobjects representing 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 service area operation.
- Parameters:
-
layerDefinition The AGSNALayerDefinitioncontaining information about the polyline barriers to be used in the analysis.
- Since:
- 1.8
Property Documentation
- (NSArray*) accumulateAttributeNames [read, write, retain] |
The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response.
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 [read, write, retain] |
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) value - Parameter value.
- Since:
- 1.8
- (NSArray*) defaultBreaks [read, write, retain] |
An array of numbers defining the breaks.
- Since:
- 1.8
- (NSArray*) excludeSourcesFromPolygons [read, write, retain] |
An array of network source names to NOT use when generating polygons.
- Since:
- 1.8
- (id) facilities [read, write, retain] |
The set of facilities loaded as network locations during analysis. Can be either an instance of AGSDataLayer or AGSFeatureSet.
- Since:
- 1.8
- (NSString*) impedanceAttributeName [read, write, copy] |
The network attribute name to be used as the impedance attribute in analysis. 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
- (BOOL) mergeSimilarPolygonRanges [read, write, assign] |
If true, similar ranges will be merged in the result polygons.
- Since:
- 1.8
- (double) outputGeometryPrecision [read, write, assign] |
The precision of the output geometry after generalization. The default is 5.0.
- Since:
- 1.8
- (AGSUnits) outputGeometryPrecisionUnits [read, write, assign] |
The units of the output geometry precision. The default value is AGSUnitsMeters.
- Since:
- 1.8
- (AGSNAOutputLine) outputLines [read, write, assign] |
The type of lines to be generated in the result.
Known values: see AGSNAOutputLine.
- Since:
- 1.8
- (AGSNAOutputPolygon) outputPolygons [read, write, assign] |
The type of output polygons to be generated in the result.
- Since:
- 1.8
- (AGSSpatialReference*) outSpatialReference [read, write, retain] |
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) overlapLines [read, write, assign] |
Indicates if the lines should overlap from multiple facilities.
- Since:
- 1.8
- (BOOL) overlapPolygons [read, write, assign] |
Indicates if the polygons should overlap from multiple facilities.
- Since:
- 1.8
- (id) pointBarriers [read, write, retain] |
The set of point barriers loaded as network locations during analysis. Can be either an instance of AGSDataLayer or AGSFeatureSet.
- Since:
- 1.8
- (id) polygonBarriers [read, write, retain] |
The set of polygons barriers loaded as network locations during analysis. Can be either an instance of AGSDataLayer or AGSFeatureSet.
- Since:
- 1.8
- (id) polylineBarriers [read, write, retain] |
The set of polyline barriers loaded as network locations during analysis. Can be either an instance of AGSDataLayer or AGSFeatureSet.
- Since:
- 1.8
- (NSArray*) restrictionAttributeNames [read, write, retain] |
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) returnFacilities [read, write, assign] |
If true, facilities will be returned with the analysis results. Default value is false.
- Since:
- 1.8
- (BOOL) returnPointBarriers [read, write, assign] |
If true, point barriers will be returned in the point barriers property of AGSServiceAreaTaskResult. The default value is false.
- Since:
- 1.8
- (BOOL) returnPolygonBarriers [read, write, assign] |
If true, polygon barriers will be returned in the polygonBarriers property of AGSServiceAreaTaskResult. The default value is false.
- Since:
- 1.8
- (BOOL) returnPolylineBarriers [read, write, assign] |
If true, polyline barriers will be returned in the polylineBarriers property of AGSServiceAreaTaskResult. The default value is false.
- Since:
- 1.8
- (BOOL) splitLinesAtBreaks [read, write, assign] |
If true, lines will be split at breaks.
- Since:
- 1.8
- (BOOL) splitPolygonsAtBreaks [read, write, assign] |
If true, polygons will be split at breaks.
- Since:
- 1.8
- (AGSNATravelDirection) travelDirection [read, write, assign] |
Options for traveling to or from the facility. Default values are defined by the newtork layer. See AGSNATravelDirection for a list of valid values.
- Since:
- 1.8
- (BOOL) trimOuterPolygon [read, write, assign] |
If true, the outermost polygon (at the maximum break value) will be trimmed. The default is defined in the network analysis layer in your ServiceAreaTask.
- Since:
- 1.8
- (double) trimPolygonDistance [read, write, assign] |
If polygons are being trimmed, provides the distance to trim. The default is defined in the network analysis layer.
- Since:
- 1.8
- (AGSUnits) trimPolygonDistanceUnits [read, write, assign] |
If polygons are being trimmed, specifies the units of the trimPolygonDistance. The default is defined in the network analysis layer.
- Since:
- 1.8
- (AGSNAUTurn) uTurns [read, write, assign] |
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