ArcGIS Runtime SDK for iOS: AGSUtilityTraceConfiguration.h Source File
ArcGIS Runtime SDK for iOS  100.9
AGSUtilityTraceConfiguration.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 1995-2020 ESRI
3 
4  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
5  Unpublished material - all rights reserved under the
6  Copyright Laws of the United States and applicable international
7  laws, treaties, and conventions.
8 
9  For additional information, contact:
10  Environmental Systems Research Institute, Inc.
11  Attn: Contracts and Legal Services Department
12  380 New York Street
13  Redlands, California, 92373
14  USA
15 
16  email: contracts@esri.com
17  */
18  //Required for Globals API doc
20 
21 #import <ArcGIS/AGSObject.h>
22 
23 
24 
26 @class AGSUtilityTier;
30 @class AGSUtilityAssetType;
34 
41 
42 #pragma mark -
43 #pragma mark initializers
44 
48 -(instancetype)init;
49 
53 +(instancetype)utilityTraceConfiguration;
54 
55 #pragma mark -
56 #pragma mark properties
57 
62 @property (nullable, nonatomic, strong, readwrite) AGSUtilityDomainNetwork *domainNetwork;
63 
67 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTraceFilter *filter;
68 
74 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityTraceFunction *> *functions;
75 
84 @property (nonatomic, assign, readwrite) BOOL ignoreBarriersAtStartingPoints;
85 
91 @property (nonatomic, assign, readwrite) BOOL includeBarriers;
92 
98 @property (nonatomic, assign, readwrite) BOOL includeContainers;
99 
104 @property (nonatomic, assign, readwrite) BOOL includeContent;
105 
111 @property (nonatomic, assign, readwrite) BOOL includeIsolatedFeatures;
112 
118 @property (nonatomic, assign, readwrite) BOOL includeStructures;
119 
129 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityAssetType *> *outputAssetTypes;
130 
142 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTraceCondition *outputCondition;
143 
150 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityPropagator *> *propagators;
151 
158 @property (nullable, nonatomic, strong, readwrite) AGSUtilityNetworkAttribute *shortestPathNetworkAttribute;
159 
168 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTier *sourceTier;
169 
176 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTier *targetTier;
177 
181 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTraversability *traversability;
182 
187 @property (nonatomic, assign, readwrite) BOOL validateConsistency;
188 
189 #pragma mark -
190 #pragma mark methods
191 
192 @end
193 
194 
AGSUtilityTraversability * traversability
Definition: AGSUtilityTraceConfiguration.h:181
NSArray< AGSUtilityPropagator * > * propagators
Definition: AGSUtilityTraceConfiguration.h:150
BOOL ignoreBarriersAtStartingPoints
Definition: AGSUtilityTraceConfiguration.h:84
A mechanism to stop tracing when returning results. AGSUtilityTraceFilter objects do not stop travers...
Definition: AGSUtilityTraceFilter.h:40
BOOL includeIsolatedFeatures
Definition: AGSUtilityTraceConfiguration.h:111
NSArray< AGSUtilityAssetType * > * outputAssetTypes
Definition: AGSUtilityTraceConfiguration.h:129
BOOL includeContainers
Definition: AGSUtilityTraceConfiguration.h:98
AGSUtilityNetworkAttribute * shortestPathNetworkAttribute
Definition: AGSUtilityTraceConfiguration.h:158
NSArray< AGSUtilityTraceFunction * > * functions
Definition: AGSUtilityTraceConfiguration.h:74
The set of utility network parameters that define elements of a trace or of a subnetwork. AGSUtilityTraceConfiguration is set in the AGSUtilityTraceParameters.
Definition: AGSUtilityTraceConfiguration.h:40
AGSUtilityTraceCondition * outputCondition
Definition: AGSUtilityTraceConfiguration.h:142
BOOL includeStructures
Definition: AGSUtilityTraceConfiguration.h:118
BOOL includeContent
Definition: AGSUtilityTraceConfiguration.h:104
Functions allow the computation of values during a network trace.
Definition: AGSUtilityTraceFunction.h:49
AGSUtilityTier * sourceTier
Definition: AGSUtilityTraceConfiguration.h:168
AGSUtilityDomainNetwork * domainNetwork
Definition: AGSUtilityTraceConfiguration.h:62
AGSUtilityTier * targetTier
Definition: AGSUtilityTraceConfiguration.h:176
A utility network asset type.
Definition: AGSUtilityAssetType.h:50
AGSUtilityTraceFilter * filter
Definition: AGSUtilityTraceConfiguration.h:67
BOOL includeBarriers
Definition: AGSUtilityTraceConfiguration.h:91
A set of options controlling what objects are evaluated or returned during a tracing operation AGSUti...
Definition: AGSUtilityTraversability.h:43
Definition: AGSObject.h:21
The base class for a utility network traversability condition.
Definition: AGSUtilityTraceCondition.h:29
BOOL validateConsistency
Definition: AGSUtilityTraceConfiguration.h:187
A network attribute in a utility network.
Definition: AGSUtilityNetworkAttribute.h:50
A domain network inside a utility network.
Definition: AGSUtilityDomainNetwork.h:60
instancetype utilityTraceConfiguration()
Propagator objects allow a subset of AGSUtilityNetworkAttribute values to propagate through a network...
Definition: AGSUtilityPropagator.h:49
Tiers demarcate a logical level within a network.
Definition: AGSUtilityTier.h:41