ArcGIS Runtime SDK for iOS: AGSUtilityNetwork.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSUtilityNetwork.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 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  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSLoadableBase.h>
29 #import <ArcGIS/AGSRemoteResource.h>
30 #import <ArcGIS/AGSUtilityAssociation.h>
31 
32 
33 
34 @class AGSArcGISFeature;
35 @class AGSMap;
36 @class AGSUtilityAssetType;
37 @class AGSUtilityElement;
39 @class AGSUtilityTerminal;
42 @class AGSEnvelope;
44 @class AGSGeodatabase;
47 
48 @protocol AGSCancelable;
49 
59 
60 #pragma mark -
61 #pragma mark initializers
62 
63 
64 
69 -(instancetype)initWithURL:(NSURL *)URL;
70 
76 +(instancetype)utilityNetworkWithURL:(NSURL *)URL;
77 
88 -(instancetype)initWithURL:(NSURL *)URL
89  map:(AGSMap *)map;
90 
102 +(instancetype)utilityNetworkWithURL:(NSURL *)URL
103  map:(AGSMap *)map;
104 
105 #pragma mark -
106 #pragma mark properties
107 
112 @property (nonatomic, strong, readonly) AGSUtilityNetworkDefinition *definition;
113 
118 @property (nonatomic, copy, readonly) NSString *name;
119 
138 @property (nullable, nonatomic, strong, readonly) AGSServiceGeodatabase *serviceGeodatabase;
139 
155 @property (nullable, nonatomic, weak, readonly) AGSGeodatabase *geodatabase;
156 
157 #pragma mark -
158 #pragma mark methods
159 
169 -(id<AGSCancelable>)associationsWithElement:(AGSUtilityElement *)element
170  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
171 
181 -(id<AGSCancelable>)associationsWithElement:(AGSUtilityElement *)element
182  type:(AGSUtilityAssociationType)type
183  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
184 
195 - (id<AGSCancelable>)associationsWithExtent:(AGSEnvelope *)extent
196  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
197 
208 - (id<AGSCancelable>)associationsWithExtent:(AGSEnvelope *)extent
209  type:(AGSUtilityAssociationType)type
210  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
211 
219 -(nullable AGSUtilityElement *)createElementWithAssetType:(AGSUtilityAssetType *)assetType
220  globalID:(NSUUID *)globalID;
221 
222 
232 -(nullable AGSUtilityElement *)createElementWithAssetType:(AGSUtilityAssetType *)assetType
233  globalID:(NSUUID *)globalID
234  terminal:(nullable AGSUtilityTerminal *)terminal;
235 
242 -(nullable AGSUtilityElement *)createElementWithFeature:(AGSArcGISFeature *)feature;
243 
252 -(nullable AGSUtilityElement *)createElementWithFeature:(AGSArcGISFeature *)feature
253  terminal:(nullable AGSUtilityTerminal *)terminal;
254 
262 -(id<AGSCancelable>)featuresForElements:(NSArray<AGSUtilityElement *> *)elements
263  completion:(void(^)(NSArray<AGSArcGISFeature *> * __nullable result, NSError * __nullable error))completion;
264 
277 -(id<AGSCancelable>)traceWithParameters:(AGSUtilityTraceParameters *)traceParameters
278  completion:(void(^)(NSArray<AGSUtilityTraceResult *> * __nullable result, NSError * __nullable error))completion;
279 
286 - (id<AGSCancelable>)queryNamedTraceConfigurationsWithQueryParameters:(nullable AGSUtilityNamedTraceConfigurationQueryParameters *)queryParameters
287  completion:(void(^)(NSArray<AGSUtilityNamedTraceConfiguration *> * _Nullable result, NSError * _Nullable error))completion;
288 
289 @end
290 
291 
AGSUtilityAssociationType
Definition: AGSUtilityAssociation.h:38
An AGSFeature object stored in an AGSArcGISFeatureTable object.
Definition: AGSArcGISFeature.h:62
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A geodatabase on disk.
Definition: AGSGeodatabase.h:45
A base class for loadables.
Definition: AGSLoadableBase.h:45
A map containing 2D geographic content.
Definition: AGSMap.h:68
A container for a collection of AGSServiceFeatureTable connected to a feature service.
Definition: AGSServiceGeodatabase.h:93
A utility network asset type.
Definition: AGSUtilityAssetType.h:58
A connectivity, containment, or structural attachment association.
Definition: AGSUtilityAssociation.h:55
An entity in a utility network that corresponds to an AGSFeature object.
Definition: AGSUtilityElement.h:43
A set of predefined trace options that can be used by the AGSUtilityTraceParameters object to simplif...
Definition: AGSUtilityNamedTraceConfiguration.h:46
The query parameters to use when searching for applicable named trace configuration objects....
Definition: AGSUtilityNamedTraceConfigurationQueryParameters.h:41
An object that represents the metadata of a utility network feature service.
Definition: AGSUtilityNetworkDefinition.h:45
A utility network.
Definition: AGSUtilityNetwork.h:58
AGSGeodatabase * geodatabase
Definition: AGSUtilityNetwork.h:155
AGSServiceGeodatabase * serviceGeodatabase
Definition: AGSUtilityNetwork.h:138
AGSUtilityNetworkDefinition * definition
Definition: AGSUtilityNetwork.h:112
NSString * name
Definition: AGSUtilityNetwork.h:118
A single terminal on a junction feature.
Definition: AGSUtilityTerminal.h:38
Utility network trace parameters.
Definition: AGSUtilityTraceParameters.h:65
The base class for trace result objects.
Definition: AGSUtilityTraceResult.h:49
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
A protocol adopted by classes that access remote network resources that have the potential to be secu...
Definition: AGSRemoteResource.h:40