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

Description

Result returned by AGSClosestFacilityTask.

Instances of this class represent the result of solveClosestFacilityWithParameters:completion: (AGSClosestFacilityTask). The result is a collection of computed routes between incidents and facilities, barriers used in the computation, and messages generated during the process.

Since
100.1
Inheritance diagram for AGSClosestFacilityResult:
AGSObject

Instance Methods

(nullable NSArray< NSNumber * > *) - facilityCostsForAttributeName:facilityIndex:
 
(nullable NSArray< NSNumber * > *) - rankedFacilityIndexesForIncidentIndex:
 
(nullable AGSClosestFacilityRoute *) - routeForFacilityIndex:incidentIndex:
 

Properties

NSString * directionsLanguage
 
NSArray< AGSFacility * > * facilities
 
NSArray< AGSIncident * > * incidents
 
NSArray< NSString * > * messages
 
NSArray< AGSPointBarrier * > * pointBarriers
 
NSArray< AGSPolygonBarrier * > * polygonBarriers
 
NSArray< AGSPolylineBarrier * > * polylineBarriers
 

Method Documentation

◆ facilityCostsForAttributeName:facilityIndex:

- (nullable NSArray<NSNumber*>*) facilityCostsForAttributeName: (NSString *)  attributeName
facilityIndex: (NSInteger)  facilityIndex 

Returns the cost for the specified facility attribute.

Parameters
attributeNamename of the desired attribute.
facilityIndexindex of the desired facility in the AGSClosestFacilityResult::facilities array.
Since
100.1

◆ rankedFacilityIndexesForIncidentIndex:

- (nullable NSArray<NSNumber*>*) rankedFacilityIndexesForIncidentIndex: (NSInteger)  incidentIndex

Returns an ordered list of facilities for a given incident. Facilities and Incidents are identified by indexes based on the facilities and incidents collections. The first element in the list is the closest facility, the second element is the next closest, etc. Multiple properties can effect the number of facilities returned for each incident.

Parameters
incidentIndexindex of the desired incident in the AGSClosestFacilityResult::incidents array.
Since
100.1

◆ routeForFacilityIndex:incidentIndex:

- (nullable AGSClosestFacilityRoute*) routeForFacilityIndex: (NSInteger)  facilityIndex
incidentIndex: (NSInteger)  incidentIndex 

Returns a route between an incident and a facility.

Parameters
facilityIndexindex of the desired facility in the AGSClosestFacilityResult::facilities array.
incidentIndexindex of the desired incident in the AGSClosestFacilityResult::incidents array.
Returns
An AGSClosestFacilityRoute between specified facility and incident.
Since
100.1

Property Documentation

◆ directionsLanguage

- (NSString*) directionsLanguage
readnonatomiccopy

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
See also
AGSClosestFacilityParameters::directionsLanguage to specify which language to use.

◆ facilities

- (NSArray<AGSFacility*>*) facilities
readnonatomiccopy

Facilities used in the analysis.

See also
AGSFacility
Since
100.1

◆ incidents

- (NSArray<AGSIncident*>*) incidents
readnonatomiccopy

Incidents used in the analysis.

See also
AGSIncident
Since
100.1

◆ messages

- (NSArray<NSString*>*) messages
readnonatomiccopy

Informational messages that were generated while computing routes.

Since
100.1

◆ pointBarriers

- (NSArray<AGSPointBarrier*>*) pointBarriers
readnonatomiccopy

Point barriers used in the route computation. Only available if AGSClosestFacilityParameters::returnPointBarriers was enabled.

Since
100.1
See also
- setPointBarriers: (AGSClosestFacilityParameters) or - setPointBarriersWithFeatureTable:queryParameters: (AGSClosestFacilityParameters) to specify the barriers to use.

◆ polygonBarriers

- (NSArray<AGSPolygonBarrier*>*) polygonBarriers
readnonatomiccopy

Polygon barriers used in the route computation. Only available if AGSClosestFacilityParameters::returnPolygonBarriers was enabled.

Since
100.1
See also
- setPolygonBarriers: (AGSClosestFacilityParameters) or - setPolygonBarriersWithFeatureTable:queryParameters: (AGSClosestFacilityParameters) to specify the barriers to use.

◆ polylineBarriers

- (NSArray<AGSPolylineBarrier*>*) polylineBarriers
readnonatomiccopy

Polyline barriers used in the route computation. Only available if AGSClosestFacilityParameters::returnPolylineBarriers was enabled.

Since
100.1
See also
- setPolylineBarriers: (AGSClosestFacilityParameters) or - setPolylineBarriersWithFeatureTable:queryParameters: (AGSClosestFacilityParameters) to specify the barriers to use.