ArcGIS Runtime SDK for iOS: AGSServiceAreaFacility Class Reference
ArcGIS Runtime SDK for iOS  100.15
AGSServiceAreaFacility Class Reference

Description

A facility to use in service area analysis.

Instances of this class represent facility locations from which service areas need to be calculated. For example, a fire station can be set as a facility to find which areas it can serve within a 10 minute service area. A hospital can be set as the facility to find what proportion of the population is within a 2 mile driving distance.

See also
AGSServiceAreaTask
Since
100.1
Inheritance diagram for AGSServiceAreaFacility:
AGSObject

Instance Methods

(double) - addedCostForCostAttribute:
 
(instancetype) - initWithPoint:
 
(void) - setAddedCost:forCostAttribute:
 

Class Methods

(instancetype) + serviceAreaFacilityWithPoint:
 

Properties

AGSCurbApproach curbApproach
 
double currentBearing
 
double currentBearingTolerance
 
double distanceToNetworkLocation
 
NSInteger facilityID
 
AGSPointgeometry
 
NSArray< NSNumber * > * impedanceCutoffs
 
AGSLocationStatus locationStatus
 
NSString * name
 
double navigationLatency
 
double navigationSpeed
 
AGSNetworkLocationnetworkLocation
 

Method Documentation

◆ addedCostForCostAttribute:

- (double) addedCostForCostAttribute: (NSString *)  attributeName

Gets the added cost value for the given impedance or accumulate attribute

Parameters
attributeNameof the impedance or accumulate attribute
Returns
added cost of the attribute
Since
100.1
See also
AGSServiceAreaTaskInfo::costAttributes for a list of attributes available for service area analysis

◆ initWithPoint:

- (instancetype) initWithPoint: (AGSPoint *)  point

Initialize the facility using the provided location

Parameters
pointwhere the facility is located
Returns
A new facility
Since
100.1

◆ serviceAreaFacilityWithPoint:

+ (instancetype) serviceAreaFacilityWithPoint: (AGSPoint *)  point

Initialize the facility using the provided location

Parameters
pointwhere the facility is located
Returns
A new facility
Since
100.1

◆ setAddedCost:forCostAttribute:

- (void) setAddedCost: (double)  addedCost
forCostAttribute: (NSString *)  attributeName 

Sets the added cost value for the given impedance or accumulate attribute

Parameters
addedCostfor the attribute
attributeNameof the impedance or accumulate attribute
Since
100.1
See also
AGSServiceAreaTaskInfo::costAttributes for a list of attributes available for service area analysis

Property Documentation

◆ curbApproach

- (AGSCurbApproach) curbApproach
readwritenonatomicassign

Specifies the direction a vehicle may arrive at or depart from the facility. For example, a school bus must approach and depart a school from its door side so that students entering/exiting the bus will not have to cross the street.

Since
100.1

◆ currentBearing

- (double) currentBearing
readwritenonatomicassign

Current bearing in degrees. Current bearing in degrees, measured clockwise from true north. Typical values are 0 to 360 or NaN, negative values will be subtracted from 360 (e.g. -15 => 345), values greater than 360 will be have 360 subtracted from them (e.g. 385 => 25). For this property to be used the bearing tolerance also has to be set.

Since
100.7

◆ currentBearingTolerance

- (double) currentBearingTolerance
readwritenonatomicassign

Current bearing tolerance in degrees. Valid values are 0 to 180 or NaN.

Since
100.7

◆ distanceToNetworkLocation

- (double) distanceToNetworkLocation
readnonatomicassign

The distance to the closest location on the underlying network in meters.

See also
networkLocation
Since
100.1

◆ facilityID

- (NSInteger) facilityID
readwritenonatomicassign

Service area facility ID. This is a caller supplied foreign key that can be used to associate output facilities with input facilities.

See also
- setFacilitiesWithFeatureTable:queryParameters: (AGSServiceAreaParameters), AGSServiceAreaResult::facilities
Since
100.6

◆ geometry

- (AGSPoint*) geometry
readnonatomicstrong

Location of the facility

Since
100.1

◆ impedanceCutoffs

- (NSArray<NSNumber*>*) impedanceCutoffs
readwritenonatomiccopy

The cutoffs for generating the service areas for this facility.

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. The cutoff is a measure of the attribute specified by AGSTravelMode::impedanceAttributeName. If this is not specified, AGSServiceAreaParameters::defaultImpedanceCutoffs will be used.

Since
100.1

◆ locationStatus

- (AGSLocationStatus) locationStatus
readnonatomicassign

The status of facility's location on the underlying network.

Since
100.1
See also
networkLocation

◆ name

- (NSString*) name
readwritenonatomiccopy

Name of the facility

Since
100.1

◆ navigationLatency

- (double) navigationLatency
readwritenonatomicassign

Navigation latency in seconds.

Since
100.7

◆ navigationSpeed

- (double) navigationSpeed
readwritenonatomicassign

Navigation speed in meters per second.

Since
100.7

◆ networkLocation

- (AGSNetworkLocation*) networkLocation
readwritenonatomicstrong

The location on the underlying transportation network where the facility is located.

Set to nil for resetting a network location.

Since
100.1
See also
locationStatus