AGSUtilityTraceParameters.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/AGSObject.h>



typedef NS_ENUM(NSInteger, AGSUtilityTraceType) {
    AGSUtilityTraceTypeConnected = 0,     
    AGSUtilityTraceTypeSubnetwork = 1,    
    AGSUtilityTraceTypeUpstream = 2,      
    AGSUtilityTraceTypeDownstream = 3,    
    AGSUtilityTraceTypeIsolation = 4,     
    AGSUtilityTraceTypeLoops = 5,         
    AGSUtilityTraceTypeShortestPath = 6   
};

@class AGSUtilityElement;
@class AGSUtilityTraceConfiguration;

@interface AGSUtilityTraceParameters : AGSObject

#pragma mark -
#pragma mark initializers



-(instancetype)initWithTraceType:(AGSUtilityTraceType)traceType 
               startingLocations:(NSArray<AGSUtilityElement *> *)startingLocations;

+(instancetype)utilityTraceParametersWithTraceType:(AGSUtilityTraceType)traceType 
                                 startingLocations:(NSArray<AGSUtilityElement *> *)startingLocations;

#pragma mark -
#pragma mark properties

@property (nonatomic, copy, readwrite) NSArray<AGSUtilityElement *> *barriers;

@property (nonatomic, copy, readwrite) NSArray<NSValue *> *resultTypes;

@property (nonatomic, copy, readwrite) NSArray<AGSUtilityElement *> *startingLocations;

@property (nullable, nonatomic, strong, readwrite) AGSUtilityTraceConfiguration *traceConfiguration;

@property (nonatomic, assign, readonly) AGSUtilityTraceType traceType;

#pragma mark -
#pragma mark methods

@end