ArcGIS Runtime SDK for iOS: AGSClosestFacilityParameters Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSClosestFacilityParameters Class Reference

Description

Input parameters for AGSClosestFacilityTask.

Instances of this class represent input parameters for finding closest facilities using AGSClosestFacilityTask.

Note
Consider using the convenience method defaultClosestFacilityParametersWithCompletion: (AGSClosestFacilityTask) to get an instance of this class that is initialized with smart default values based on the task's metadata (AGSClosestFacilityTask::closestFacilityTaskInfo)
Since
100.1
Inheritance diagram for AGSClosestFacilityParameters:
AGSObject

Instance Methods

(void) - clearFacilities
 
(void) - clearIncidents
 
(void) - clearPointBarriers
 
(void) - clearPolygonBarriers
 
(void) - clearPolylineBarriers
 
(NSString *) - searchWhereClauseForSourceName:
 
(void) - setFacilities:
 
(void) - setFacilitiesWithFeatureTable:queryParameters:
 
(void) - setIncidents:
 
(void) - setIncidentsWithFeatureTable:queryParameters:
 
(void) - setPointBarriers:
 
(void) - setPointBarriersWithFeatureTable:queryParameters:
 
(void) - setPolygonBarriers:
 
(void) - setPolygonBarriersWithFeatureTable:queryParameters:
 
(void) - setPolylineBarriers:
 
(void) - setPolylineBarriersWithFeatureTable:queryParameters:
 
(void) - setSearchWhereClause:forSourceName:
 

Properties

NSArray< NSString * > * accumulateAttributeNames
 
double defaultImpedanceCutoff
 
NSInteger defaultTargetFacilityCount
 
AGSUnitSystem directionsDistanceUnits
 
NSString * directionsLanguage
 
AGSDirectionsStyle directionsStyle
 
AGSSpatialReferenceoutputSpatialReference
 
BOOL returnDirections
 
BOOL returnPointBarriers
 
BOOL returnPolygonBarriers
 
BOOL returnPolylineBarriers
 
BOOL returnRoutes
 
AGSRouteShapeType routeShapeType
 
NSDate * startTime
 
AGSStartTimeUsage startTimeUsage
 
AGSTravelDirection travelDirection
 
AGSTravelModetravelMode
 

Method Documentation

◆ clearFacilities

- (void) clearFacilities

Clears facilities.

Clears facilities that were set by setFacilities: or setFacilitiesWithFeatureTable:queryParameters:.

Since
100.1

◆ clearIncidents

- (void) clearIncidents

Clears incidents.

Clears incidents that were set by setIncidents: or setIncidentsWithFeatureTable:queryParameters:.

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

◆ 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 facilities and incidents be located only on certain sources.

Parameters
sourceNameof the network element the filter applies to
Returns
The filter specifiying which network elements can facilities and incidents be located on
Since
100.1

◆ setFacilities:

- (void) setFacilities: (NSArray< AGSFacility * > *)  facilities

Set the facilities to use in the analysis

Parameters
facilitiesAn array of AGSFacility instances.
Since
100.1

◆ setFacilitiesWithFeatureTable:queryParameters:

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

Set the facilities to use in the analysis

Parameters
featureTablecontaining point features to use as facilities
queryParametersspecifying which features to use
Since
100.1

◆ setIncidents:

- (void) setIncidents: (NSArray< AGSIncident * > *)  incidents

Set the incidents to use in the analysis

Parameters
incidentsAn array of AGSIncident instances.
Since
100.1

◆ setIncidentsWithFeatureTable:queryParameters:

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

Set the incidents to use in the analysis

Parameters
featureTablecontaining point features to use as incidents
queryParametersto filter which features to use
Since
100.1

◆ setPointBarriers:

- (void) setPointBarriers: (NSArray< AGSPointBarrier * > *)  pointBarriers

Set point barriers to avoid in the result route

Parameters
pointBarriersAn array of AGSPointBarrier instances to avoid.
Since
100.1

◆ setPointBarriersWithFeatureTable:queryParameters:

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

Set point barriers to avoid in the result route

Parameters
featureTablecontaining point features to use as barriers
queryParametersto filter which features to use
Since
100.1

◆ setPolygonBarriers:

- (void) setPolygonBarriers: (NSArray< AGSPolygonBarrier * > *)  polygonBarriers

Set polygon barriers to avoid in the result route

Parameters
polygonBarriersAn array of AGSPolygonBarrier instances to avoid.
Since
100.1

◆ setPolygonBarriersWithFeatureTable:queryParameters:

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

Set polygon barriers to avoid in the result route

Parameters
featureTablecontaining polygon features to use as barriers
queryParametersto filter which features to use
Since
100.1

◆ setPolylineBarriers:

- (void) setPolylineBarriers: (NSArray< AGSPolylineBarrier * > *)  lineBarriers

Set polyline barriers to avoid in the result route

Parameters
lineBarriersAn array of AGSPolylineBarrier instances to avoid.
Since
100.1

◆ setPolylineBarriersWithFeatureTable:queryParameters:

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

Set polyline barriers to avoid in the result route

Parameters
featureTablecontaining polyline features to use as barriers
queryParametersto filter which features to use
Since
100.1

◆ setSearchWhereClause:forSourceName:

- (void) setSearchWhereClause: (NSString *)  searchWhereClause
forSourceName: (NSString *)  sourceName 

Specifies which network elements facilities and incidents 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 facilities and incidents be located only on certain sources.

Parameters
searchWhereClauseThe filter specifiying which network elements facilities and incidents can be located on
sourceNamethe network elements the filter applies to
Since
100.1

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. Available attributes are specified by AGSClosestFacilityTaskInfo::accumulateAttributeNames. These attributes represent costs such as Drive Time, Distance, Toll expenses, etc.

Since
100.1

◆ defaultImpedanceCutoff

- (double) defaultImpedanceCutoff
readwritenonatomicassign

Specifies the default cutoff beyond which incidents or facilities will not be searched. Each facility or incident can specify its own cutoff value, but if they don't, this default will be used. The cutoff is a measure of the attribute specified by AGSTravelMode::impedanceAttributeName

See also
AGSFacility::impedanceCutoff
AGSIncident::impedanceCutoff
Since
100.1

◆ defaultTargetFacilityCount

- (NSInteger) defaultTargetFacilityCount
readwritenonatomicassign

Specfies the default number of facilities to search for each incident. Each incident can specify its own value, but if they don't, this default will be used.

See also
AGSIncident::targetFacilityCount
Since
100.1

◆ directionsDistanceUnits

- (AGSUnitSystem) directionsDistanceUnits
readwritenonatomicassign

The linear units to use while providing distances for turn-by-turn directions.

Since
100.1

◆ 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 AGSClosestFacilityTaskInfo::supportedLanguages

Since
100.1

◆ directionsStyle

- (AGSDirectionsStyle) directionsStyle
readwritenonatomicassign

The style to use for providing directions.

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

Since
100.1

◆ returnDirections

- (BOOL) returnDirections
readwritenonatomicassign

Specifies whether to return turn-by-turn directions in the result AGSClosestFacilityRoute::directionManeuvers

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 AGSClosestFacilityResult::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 AGSClosestFacilityResult::polygonBarriers

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 AGSClosestFacilityResult::polylineBarriers

Since
100.1

◆ returnRoutes

- (BOOL) returnRoutes
readwritenonatomicassign

Specifies whether to return routes in the result routeForFacilityIndex:incidentIndex: (AGSClosestFacilityResult)

Since
100.1

◆ routeShapeType

- (AGSRouteShapeType) routeShapeType
readwritenonatomicassign

Specifies the type of route geometry to return

Since
100.1

◆ startTime

- (NSDate*) startTime
readwritenonatomicstrong

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

Since
100.1
See also
startTimeUsage

◆ startTimeUsage

- (AGSStartTimeUsage) startTimeUsage
readwritenonatomicassign

Determines whether the startTime is used as the time of departing from the facility or incident, or time of arriving at the facility or incident.

Since
100.1

◆ travelDirection

- (AGSTravelDirection) travelDirection
readwritenonatomicassign

Specifies the direction of travel between facilities and incidents. The direction of travel may influence the facilities found if the network contains one-way streets or impedances based on the direction of travel. For instance, it might take 10 minutes to drive from a particular incident to a particular facility, but the journey might take 15 minutes traveling in the other direction, from the facility to the incident, because of one-way streets or different traffic conditions.

Since
100.1

◆ travelMode

- (AGSTravelMode*) travelMode
readwritenonatomicstrong

Specifies the travel mode to use when computing the routes. 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