AGSUtilityNetwork.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc
 
#import <Foundation/Foundation.h>
#import <ArcGIS/AGSLoadableBase.h>
#import <ArcGIS/AGSRemoteResource.h>
#import <ArcGIS/AGSUtilityAssociation.h>
#import <ArcGIS/AGSCancelable.h>
 
 
 
@class AGSArcGISFeature;
@class AGSMap;
@class AGSUtilityAssetType;
@class AGSUtilityElement;
@class AGSUtilityNetworkDefinition;
@class AGSUtilityTerminal;
@class AGSUtilityTraceParameters;
@class AGSUtilityTraceResult;
@class AGSEnvelope;
@class AGSServiceGeodatabase;
@class AGSGeodatabase;
@class AGSUtilityNamedTraceConfiguration;
@class AGSUtilityNamedTraceConfigurationQueryParameters;
 
@interface AGSUtilityNetwork : AGSLoadableBase <AGSRemoteResource>
 
#pragma mark -
#pragma mark initializers
 
 
 
-(instancetype)initWithURL:(NSURL *)URL;
 
+(instancetype)utilityNetworkWithURL:(NSURL *)URL;
 
-(instancetype)initWithURL:(NSURL *)URL
                       map:(AGSMap *)map;
 
+(instancetype)utilityNetworkWithURL:(NSURL *)URL
                                 map:(AGSMap *)map;
 
#pragma mark -
#pragma mark properties
 
@property (nonatomic, strong, readonly) AGSUtilityNetworkDefinition *definition;
 
@property (nonatomic, copy, readonly) NSString *name;
 
@property (nullable, nonatomic, strong, readonly) AGSServiceGeodatabase *serviceGeodatabase;
 
@property (nullable, nonatomic, weak, readonly) AGSGeodatabase *geodatabase;
 
#pragma mark -
#pragma mark methods
 
-(id<AGSCancelable>)associationsWithElement:(AGSUtilityElement *)element
                                 completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
 
-(id<AGSCancelable>)associationsWithElement:(AGSUtilityElement *)element
                                       type:(AGSUtilityAssociationType)type
                                 completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
 
- (id<AGSCancelable>)associationsWithExtent:(AGSEnvelope *)extent
                                 completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
 
- (id<AGSCancelable>)associationsWithExtent:(AGSEnvelope *)extent
                                       type:(AGSUtilityAssociationType)type
                                 completion:(void(^)(NSArray<AGSUtilityAssociation *> * __nullable result, NSError * __nullable error))completion;
 
-(nullable AGSUtilityElement *)createElementWithAssetType:(AGSUtilityAssetType *)assetType
                                                 globalID:(NSUUID *)globalID;
 
 
-(nullable AGSUtilityElement *)createElementWithAssetType:(AGSUtilityAssetType *)assetType
                                                 globalID:(NSUUID *)globalID
                                                 terminal:(nullable AGSUtilityTerminal *)terminal;
 
-(nullable AGSUtilityElement *)createElementWithFeature:(AGSArcGISFeature *)feature;
 
-(nullable AGSUtilityElement *)createElementWithFeature:(AGSArcGISFeature *)feature
                                               terminal:(nullable AGSUtilityTerminal *)terminal;
 
-(id<AGSCancelable>)featuresForElements:(NSArray<AGSUtilityElement *> *)elements
                             completion:(void(^)(NSArray<AGSArcGISFeature *> * __nullable result, NSError * __nullable error))completion;
 
-(id<AGSCancelable>)traceWithParameters:(AGSUtilityTraceParameters *)traceParameters
                             completion:(void(^)(NSArray<AGSUtilityTraceResult *> * __nullable result, NSError * __nullable error))completion;
 
- (id<AGSCancelable>)queryNamedTraceConfigurationsWithQueryParameters:(nullable AGSUtilityNamedTraceConfigurationQueryParameters *)queryParameters
                                                           completion:(void(^)(NSArray<AGSUtilityNamedTraceConfiguration *> * _Nullable result, NSError * _Nullable error))completion;
 
@end