ArcGIS Runtime SDK for iOS: AGSUtilityNetwork.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSUtilityNetwork.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  //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 #import <ArcGIS/AGSCancelable.h>
32 
33 
34 
35 @class AGSArcGISFeature;
36 @class AGSMap;
37 @class AGSUtilityAssetType;
38 @class AGSUtilityElement;
40 @class AGSUtilityTerminal;
43 @class AGSEnvelope;
45 @class AGSGeodatabase;
48 
58 
59 #pragma mark -
60 #pragma mark initializers
61 
62 
63 
68 -(instancetype)initWithURL:(NSURL *)URL;
69 
75 +(instancetype)utilityNetworkWithURL:(NSURL *)URL;
76 
87 -(instancetype)initWithURL:(NSURL *)URL
88  map:(AGSMap *)map;
89 
101 +(instancetype)utilityNetworkWithURL:(NSURL *)URL
102  map:(AGSMap *)map;
103 
104 #pragma mark -
105 #pragma mark properties
106 
111 @property (nonatomic, strong, readonly) AGSUtilityNetworkDefinition *definition;
112 
117 @property (nonatomic, copy, readonly) NSString *name;
118 
137 @property (nullable, nonatomic, strong, readonly) AGSServiceGeodatabase *serviceGeodatabase;
138 
154 @property (nullable, nonatomic, weak, readonly) AGSGeodatabase *geodatabase;
155 
156 #pragma mark -
157 #pragma mark methods
158 
168 -(id<AGSCancelable>)associationsWithElement:(AGSUtilityElement *)element
169  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
170 
180 -(id<AGSCancelable>)associationsWithElement:(AGSUtilityElement *)element
181  type:(AGSUtilityAssociationType)type
182  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
183 
194 - (id<AGSCancelable>)associationsWithExtent:(AGSEnvelope *)extent
195  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
196 
207 - (id<AGSCancelable>)associationsWithExtent:(AGSEnvelope *)extent
208  type:(AGSUtilityAssociationType)type
209  completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
210 
218 -(nullable AGSUtilityElement *)createElementWithAssetType:(AGSUtilityAssetType *)assetType
219  globalID:(NSUUID *)globalID;
220 
221 
231 -(nullable AGSUtilityElement *)createElementWithAssetType:(AGSUtilityAssetType *)assetType
232  globalID:(NSUUID *)globalID
233  terminal:(nullable AGSUtilityTerminal *)terminal;
234 
241 -(nullable AGSUtilityElement *)createElementWithFeature:(AGSArcGISFeature *)feature;
242 
251 -(nullable AGSUtilityElement *)createElementWithFeature:(AGSArcGISFeature *)feature
252  terminal:(nullable AGSUtilityTerminal *)terminal;
253 
261 -(id<AGSCancelable>)featuresForElements:(NSArray<AGSUtilityElement *> *)elements
262  completion:(void(^)(NSArray<AGSArcGISFeature *> * __nullable result, NSError * __nullable error))completion;
263 
279 -(id<AGSCancelable>)traceWithParameters:(AGSUtilityTraceParameters *)traceParameters
280  completion:(void(^)(NSArray<AGSUtilityTraceResult *> * __nullable result, NSError * __nullable error))completion;
281 
289 - (id<AGSCancelable>)queryNamedTraceConfigurationsWithQueryParameters:(nullable AGSUtilityNamedTraceConfigurationQueryParameters *)queryParameters
290  completion:(void(^)(NSArray<AGSUtilityNamedTraceConfiguration *> * _Nullable result, NSError * _Nullable error))completion;
291 
292 @end
293 
294 
AGSUtilityAssociationType
Definition: AGSUtilityAssociation.h:38
An AGSFeature object stored in an AGSArcGISFeatureTable object.
Definition: AGSArcGISFeature.h:61
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A geodatabase on disk.
Definition: AGSGeodatabase.h:49
A base class for loadables.
Definition: AGSLoadableBase.h:45
A map containing 2D geographic content.
Definition: AGSMap.h:61
A container for a collection of AGSServiceFeatureTable connected to a feature service.
Definition: AGSServiceGeodatabase.h:73
A utility network asset type.
Definition: AGSUtilityAssetType.h:72
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:45
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.
Definition: AGSUtilityNetworkDefinition.h:45
A utility network.
Definition: AGSUtilityNetwork.h:57
AGSGeodatabase * geodatabase
Definition: AGSUtilityNetwork.h:154
AGSServiceGeodatabase * serviceGeodatabase
Definition: AGSUtilityNetwork.h:137
AGSUtilityNetworkDefinition * definition
Definition: AGSUtilityNetwork.h:111
NSString * name
Definition: AGSUtilityNetwork.h:117
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