AGSServiceAreaParameters Class Reference

Description

Input parameters for AGSServiceAreaTask.

Instances of this class represent input parameters for finding service areas using AGSServiceAreaTask.

Note

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

Since

100.1

Inheritance diagram for AGSServiceAreaParameters:

Instance Methods
(void)	- clearFacilities
(void)	- clearPointBarriers
(void)	- clearPolygonBarriers
(void)	- clearPolylineBarriers
(NSString *)	- searchWhereClauseWithSourceName:
(void)	- setFacilities:
(void)	- setFacilitiesWithFeatureTable:queryParameters:
(void)	- setPointBarriers:
(void)	- setPointBarriersWithFeatureTable:queryParameters:
(void)	- setPolygonBarriers:
(void)	- setPolygonBarriersWithFeatureTable:queryParameters:
(void)	- setPolylineBarriers:
(void)	- setPolylineBarriersWithFeatureTable:queryParameters:
(void)	- setSearchWhereClauseWithSourceName:searchWhereClause:

Properties
NSArray< NSString * > *	accumulateAttributeNames
NSArray< NSNumber * > *	defaultImpedanceCutoffs
AGSServiceAreaPolygonCutoffGeometry	geometryAtCutoff
AGSServiceAreaOverlapGeometry	geometryAtOverlap
AGSSpatialReference *	outputSpatialReference
double	polygonBufferDistance
AGSServiceAreaPolygonDetail	polygonDetail
BOOL	returnPointBarriers
BOOL	returnPolygonBarriers
BOOL	returnPolygons
BOOL	returnPolylineBarriers
BOOL	returnPolylines
NSDate *	startTime
AGSTravelDirection	travelDirection
AGSTravelMode *	travelMode

Method Documentation

clearFacilities

- (void) clearFacilities

Clear any facilities that may have been set earlier

Since

100.1

clearPointBarriers

- (void) clearPointBarriers

Clears point barriers.

Clears point barriers that were set by setPointBarriers: or setPointBarriersWithFeatureTable:queryParameters:.

Since

100.1

clearPolygonBarriers

- (void) clearPolygonBarriers

Clears polygon barriers.

Clears polygon barriers that were set by setPolygonBarriers: or setPolygonBarriersWithFeatureTable:queryParameters:.

Since

100.1

clearPolylineBarriers

- (void) clearPolylineBarriers

Clears polyline barriers.

Clears polyline barriers that were set by setPolylineBarriers: or setPolylineBarriersWithFeatureTable:queryParameters:.

Since

100.1

searchWhereClauseWithSourceName:

- (NSString *) searchWhereClauseWithSourceName:

(NSString *)

sourceName

Gets the search where clause from the specified network dataset's source feature class.

Parameters

sourceName

The name of the network dataset's source feature class to retrieve the where clause from.

Returns

A NSString containing the where clause to search.

Since

100.6

setFacilities:

- (void) setFacilities:

(NSArray< AGSServiceAreaFacility * > *)

facilities

Set the facilities to use in the analysis

Parameters

facilities

an array of AGSServiceAreaFacility to use.

Since

100.1

setFacilitiesWithFeatureTable:queryParameters:

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

Set the facilities to use in the analysis

Parameters

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

Since

100.1

setPointBarriers:

- (void) setPointBarriers:

(NSArray< AGSPointBarrier * > *)

pointBarriers

Set point barriers to avoid while computing the service area

Parameters

pointBarriers

an array of AGSPointBarrier barriers to avoid.

Since

100.1

setPointBarriersWithFeatureTable:queryParameters:

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

Set point barriers to avoid while computing the service area

Parameters

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

Since

100.1

setPolygonBarriers:

- (void) setPolygonBarriers:

(NSArray< AGSPolygonBarrier * > *)

polygonBarriers

Set polygon barriers to avoid while computing the service area

Parameters

polygonBarriers

an array of AGSPolygonBarrier barriers to avoid.

Since

100.1

setPolygonBarriersWithFeatureTable:queryParameters:

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

Set polygon barriers to avoid while computing the service area

Parameters

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

Since

100.1

setPolylineBarriers:

- (void) setPolylineBarriers:

(NSArray< AGSPolylineBarrier * > *)

lineBarriers

Set polyline barriers to avoid while computing the service area

Parameters

lineBarriers

an array of AGSPolylineBarrier barriers to avoid.

Since

100.1

setPolylineBarriersWithFeatureTable:queryParameters:

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

Set polyline barriers to avoid while computing the service area

Parameters

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

Since

100.1

setSearchWhereClauseWithSourceName:searchWhereClause:

- (void) setSearchWhereClauseWithSourceName:		(NSString *)	sourceName
searchWhereClause:		(NSString *)	searchWhereClause

Sets a search where clause on the specified network dataset's source feature class. Only features satisfying the where clause for the specified feature class will be used to locate facilities on the network during the solve operation. If a where clause is not set all network features are used.

Parameters

sourceName	The name of the network dataset's source feature class the where clause will be applied to.
searchWhereClause	The search where clause.

Since

100.6

Property Documentation

accumulateAttributeNames

- (NSArray<NSString*>*) accumulateAttributeNames

readwritenonatomiccopy

A list of network attributes to be accumulated and returned as part of the result. You might want to perform the analysis using a distance-based impedance attribute and accumulate a time-based cost attribute. The results of this kind of analysis are based on distance, but they also specify how long it would take to reach a portion of the service area. Available attributes are specified by AGSServiceAreaTaskInfo::accumulateAttributeNames. These attributes represent costs such as Drive Time, Distance, Toll expenses, etc.

Since

100.1

defaultImpedanceCutoffs

- (NSArray<NSNumber*>*) defaultImpedanceCutoffs

readwritenonatomiccopy

Specifies the default cutoffs for generating the service areas.

Each facility can specify its own cutoff values, but if they don't, this default will be used. The cutoff is a measure of the attribute specified by AGSTravelMode::impedanceAttributeName.

Cutoffs specify the quantity of the impedance to apply. They constrain the extent of the service area to be calculated. For example, if you apply breaks of 5, 10, and 15 when the impedance is set to time, the service area will include those streets that can be reached within 5, 10, and 15 minutes.

See also

AGSFacility::impedanceCutoff

Since

100.1

geometryAtCutoff

- (AGSServiceAreaPolygonCutoffGeometry) geometryAtCutoff

readwritenonatomicassign

The type of service area geometries to generate at each cutoff when multiple cutoff values are specified. This parameter does not apply to line output.

Since

100.1

geometryAtOverlap

- (AGSServiceAreaOverlapGeometry) geometryAtOverlap

readwritenonatomicassign

Options available for generating polygons or lines for multiple facilities in relation to one another.

Since

100.1

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 AGSServiceAreaTaskInfo::outputSpatialReference.

Since

100.1

polygonBufferDistance

- (double) polygonBufferDistance

readwritenonatomicassign

Amount by which to buffer the output service area polygons. Specified in units of the outputSpatialReference. The buffer refers to the distance from the road the service area polygon should extend when no other reachable roads are nearby, similar to a line buffer size. This is useful if the network is very sparse and you don't want the service area to cover large areas where there are no features.

Since

100.1

polygonDetail

- (AGSServiceAreaPolygonDetail) polygonDetail

readwritenonatomicassign

The level of detail for output service area polygons

Since

100.1

returnPointBarriers

- (BOOL) returnPointBarriers

readwritenonatomicassign

Specifies whether to return the point barriers used while computing the result. The barriers will be returned in AGSServiceAreaResult::pointBarriers

Since

100.1

returnPolygonBarriers

- (BOOL) returnPolygonBarriers

readwritenonatomicassign

Specifies whether to return the polygon barriers used while computing the result. The barriers will be returned in AGSServiceAreaResult::polygonBarriers

Since

100.1

returnPolygons

- (BOOL) returnPolygons

readwritenonatomicassign

Specifies whether to return the service area result geometries as polygons. Default is true.

Since

100.1

returnPolylineBarriers

- (BOOL) returnPolylineBarriers

readwritenonatomicassign

Specifies whether to return the polyline barriers used while computing the result. The barriers will be returned in AGSServiceAreaResult::polylineBarriers

Since

100.1

returnPolylines

- (BOOL) returnPolylines

readwritenonatomicassign

Specifies whether to return the service area result geometries as polylines. Default if false.

Since

100.1

startTime

- (NSDate*) startTime

readwritenonatomicstrong

Specifies when the service area starts from or finishes at the facility. If not specified, defaults to the time the task is executed.

Since

100.1

travelDirection

- (AGSTravelDirection) travelDirection

readwritenonatomicassign

Specifies the direction of travel for the service area computation. The direction you should choose depends on the nature of your service area analysis. The service area for a pizza delivery store, for example, should be created away from the facility since pizzas are delivered from the store to the customer. Alternatively, a hospital should choose the opposite direction since the urgent part of the trip for an incoming patient is going to the hospital, not returning home afterwards.

Since

100.1

travelMode

- (AGSTravelMode*) travelMode

readwritenonatomicstrong

Specifies the travel mode to use when computing the service areas. A travel mode represents a collection of network settings, such as travel restrictions and U-turn policies, that determine how a pedestrian, car, truck, or other medium of transportation moves through the network.

Since

100.1