AGSClosestFacilityTaskParameters Class Reference
Description
Instances of this class represent parameters to be used as input to the AGSClosestFacilityTask.
The default parameters for an AGSClosestFacilityTask can be retrieved by passing AGSClosestFacilityTask the retrieveDefaultClosestFacilityTaskParameters message and listening to the closestFacilityTask:operation:didRetrieveDefaultClosestFacilityTaskParameters: delegate method. @ since 1.8
Member Function Documentation
| + (id) closestFacilityTaskParameters |
Initialize an autoreleased AGSClosestFacilityTaskParameters object.
- Since:
- 1.8
| - (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
| - (void) setFacilitiesWithFeatures: | (NSArray *) | features |
Set the facilities to be used in the closest facility 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 closest facility operation.
- Parameters:
-
layerDefinition The AGSNALayerDefinitioncontaining information about the facilities to be used in the analysis.
- Since:
- 1.8
| - (void) setIncidentsWithFeatures: | (NSArray *) | features |
Set the incidents to be used in the closest facility operation.
- Parameters:
-
features An array of AGSGraphicobjects representing features to be used as incidents in the analysis.
- Since:
- 1.8
| - (void) setIncidentsWithLayerDefinition: | (AGSNALayerDefinition *) | layerDefinition |
Set the layer information for the incidents to be used in the closest facility operation.
- Parameters:
-
layerDefinition The AGSNALayerDefinitioncontaining information about the incidents to be used in the analysis.
- Since:
- 1.8
| - (void) setPointBarriersWithFeatures: | (NSArray *) | features |
Set the point barriers to be used in the solve 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 solve 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 solve 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 solve 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 solve 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 solve 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.
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 [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
- (double) defaultCutoffValue [read, write, assign] |
The cutoff value used to determine when to stop traversing.
- Since:
- 1.8
- (int) defaultTargetFacilityCount [read, write, assign] |
The number of facilities to find.
- Since:
- 1.8
- (NSString*) directionsLanguage [read, write, retain] |
The language used when computing directions. The default is as defined by the network analysis layer used in your task.
- Since:
- 1.8
- (AGSNAUnit) directionsLengthUnits [read, write, assign] |
The length units used when computing directions. The default is as defined by the network analysis layer used in your task.
- Since:
- 1.8
- (NSString*) directionsStyleName [read, write, retain] |
- Since:
- 1.8
- (NSString*) directionsTimeAttributeName [read, write, retain] |
The name of the attribute field that contains the drive time values. If not specified the task will use the attribute field defined by the closest facility network layer.
- Since:
- 1.8
- (NSString*) impedanceAttributeName [read, write, retain] |
The network attribute name to be used as the impedance attribute in analysis. The default is as defined in the specific closest facility network 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 [read, write, assign] |
The output geometry precision. The default value 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. The default is as defined in the specific closest facility network layer used in your task.
Known values: see AGSNAOutputLine.
- 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
- (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) returnDirections [read, write, assign] |
If true, directions will be generated and returned in the directions property of each AGSRouteResult and AGSRouteTaskResult. Default value is false.
- 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) returnIncidents [read, write, assign] |
If true, incidents will be returned with the analysis results. Default value is false.
- Since:
- 1.8
- (BOOL) returnPointBarriers [read, write, assign] |
If true, barriers will be returned in the barriers property of the AGSClosestFacilityTaskResult. Default value is false.
- Since:
- 1.8
- (BOOL) returnPolygonBarriers [read, write, assign] |
If true, polygon barriers will be returned in the polygon barriers property of the AGSClosestFacilityTaskResult. Default value is false.
- Since:
- 1.8
- (BOOL) returnPolylineBarriers [read, write, assign] |
If true, polyline barriers will be returned in the polyline barriers property of the AGSClosestFacilityTaskResult. Default value is false.
- Since:
- 1.8
- (BOOL) returnRouteGraphics [read, write, assign] |
When true, closest facility routes will be generated and returned in the route property of each AGSClosestFacilityResult and AGSClosestFacilityTaskResult. Default value is true.
- Since:
- 1.8
- (AGSNATravelDirection) travelDirection [read, write, assign] |
Options for traveling to or from the facility.
- Since:
- 1.8
- (BOOL) useHierarchy [read, write, assign] |
If true, the hierarchy attribute for the network will be used in analysis.
- 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