ArcGIS Runtime SDK for iOS: AGSFacility.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSFacility.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSObject.h>
27 #import <ArcGIS/AGSRouteTypes.h>
28 
29 @class AGSPoint;
30 @class AGSNetworkLocation;
31  //Required for Globals API doc
33 
41 @interface AGSFacility : AGSObject <NSCopying>
42 
43 
44 #pragma mark -
45 #pragma mark initializers
46 
47 
48 
54 -(instancetype)initWithPoint:(AGSPoint*)point;
55 
61 +(instancetype)facilityWithPoint:(AGSPoint*)point;
62 
63 #pragma mark -
64 #pragma mark properties
65 
70 @property (nonatomic, assign, readwrite) AGSCurbApproach curbApproach;
71 
76 @property (nonatomic, assign, readonly) double distanceToNetworkLocation;
77 
83 @property (nonatomic, assign, readwrite) NSInteger facilityID;
84 
88 @property (nonatomic, strong, readonly) AGSPoint *geometry;
89 
93 @property (nonatomic, assign, readwrite) double impedanceCutoff;
94 
99 @property (nonatomic, assign, readonly) AGSLocationStatus locationStatus;
100 
104 @property (nonatomic, copy, readwrite) NSString *name;
105 
112 @property (nullable, nonatomic, strong, readwrite) AGSNetworkLocation *networkLocation;
113 
120 @property (nonatomic, assign, readwrite) double currentBearing;
121 
125 @property (nonatomic, assign, readwrite) double currentBearingTolerance;
126 
130 @property (nonatomic, assign, readwrite) double navigationLatency;
131 
135 @property (nonatomic, assign, readwrite) double navigationSpeed;
136 
137 #pragma mark -
138 #pragma mark methods
139 
146 -(double)addedCostForCostAttribute:(NSString*)attributeName;
147 
154  -(void)setAddedCost:(double)addedCost forCostAttribute:(NSString*)attributeName;
155 
156 
157 @end
AGSLocationStatus
Definition: AGSRouteTypes.h:57
AGSCurbApproach
Definition: AGSRouteTypes.h:35
A facility to use in closest facility or service area analysis.
Definition: AGSFacility.h:41
AGSLocationStatus locationStatus
Definition: AGSFacility.h:99
double currentBearing
Definition: AGSFacility.h:120
double navigationLatency
Definition: AGSFacility.h:130
double currentBearingTolerance
Definition: AGSFacility.h:125
double impedanceCutoff
Definition: AGSFacility.h:93
double navigationSpeed
Definition: AGSFacility.h:135
NSInteger facilityID
Definition: AGSFacility.h:83
double distanceToNetworkLocation
Definition: AGSFacility.h:76
AGSNetworkLocation * networkLocation
Definition: AGSFacility.h:112
NSString * name
Definition: AGSFacility.h:104
AGSCurbApproach curbApproach
Definition: AGSFacility.h:70
AGSPoint * geometry
Definition: AGSFacility.h:88
References a specific location/position along a transportation network source feature.
Definition: AGSNetworkLocation.h:39
Definition: AGSObject.h:28
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73