AGSUtilityNetwork.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 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 <ArcGIS/AGSLoadableBase.h>
#import <ArcGIS/AGSRemoteResource.h>
#import <ArcGIS/AGSUtilityAssociation.h>



@class AGSArcGISFeature;
@class AGSMap;
@class AGSUtilityAssetType;
@class AGSUtilityElement;
@class AGSUtilityNetworkDefinition;
@class AGSUtilityTerminal;
@class AGSUtilityTraceParameters;
@class AGSUtilityTraceResult;
@class AGSEnvelope;

@protocol AGSCancelable;

@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;

#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;

@end