ArcGIS Runtime SDK for iOS: AGSUtilityTraceConfiguration.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSUtilityTraceConfiguration.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 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/AGSObject.h>
29 
30 
31 
33 @class AGSUtilityTier;
37 @class AGSUtilityAssetType;
41 
47 
48 #pragma mark -
49 #pragma mark initializers
50 
54 -(instancetype)init;
55 
60 +(instancetype)utilityTraceConfiguration;
61 
62 #pragma mark -
63 #pragma mark properties
64 
69 @property (nullable, nonatomic, strong, readwrite) AGSUtilityDomainNetwork *domainNetwork;
70 
74 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTraceFilter *filter;
75 
81 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityTraceFunction *> *functions;
82 
91 @property (nonatomic, assign, readwrite) BOOL ignoreBarriersAtStartingPoints;
92 
97 @property (nonatomic, assign, readwrite) BOOL includeBarriers;
98 
103 @property (nonatomic, assign, readwrite) BOOL includeContainers;
104 
109 @property (nonatomic, assign, readwrite) BOOL includeContent;
110 
115 @property (nonatomic, assign, readwrite) BOOL includeIsolatedFeatures;
116 
121 @property (nonatomic, assign, readwrite) BOOL includeStructures;
122 
132 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityAssetType *> *outputAssetTypes;
133 
145 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTraceCondition *outputCondition;
146 
153 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityPropagator *> *propagators;
154 
161 @property (nullable, nonatomic, strong, readwrite) AGSUtilityNetworkAttribute *shortestPathNetworkAttribute;
162 
171 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTier *sourceTier;
172 
179 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTier *targetTier;
180 
184 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTraversability *traversability;
185 
190 @property (nonatomic, assign, readwrite) BOOL validateConsistency;
191 
192 #pragma mark -
193 #pragma mark methods
194 
195 @end
196 
197 
Definition: AGSObject.h:28
A utility network asset type.
Definition: AGSUtilityAssetType.h:58
A domain network inside a utility network.
Definition: AGSUtilityDomainNetwork.h:68
A network attribute in a utility network.
Definition: AGSUtilityNetworkAttribute.h:58
Propagator objects allow a subset of AGSUtilityNetworkAttribute values to propagate through a network...
Definition: AGSUtilityPropagator.h:57
Tiers demarcate a logical level within a network.
Definition: AGSUtilityTier.h:49
The base class for a utility network traversability condition.
Definition: AGSUtilityTraceCondition.h:37
The set of utility network parameters that define elements of a trace or of a subnetwork....
Definition: AGSUtilityTraceConfiguration.h:47
BOOL ignoreBarriersAtStartingPoints
Definition: AGSUtilityTraceConfiguration.h:91
AGSUtilityTraceCondition * outputCondition
Definition: AGSUtilityTraceConfiguration.h:145
NSArray< AGSUtilityPropagator * > * propagators
Definition: AGSUtilityTraceConfiguration.h:153
BOOL includeStructures
Definition: AGSUtilityTraceConfiguration.h:121
BOOL includeBarriers
Definition: AGSUtilityTraceConfiguration.h:97
NSArray< AGSUtilityAssetType * > * outputAssetTypes
Definition: AGSUtilityTraceConfiguration.h:132
AGSUtilityTier * targetTier
Definition: AGSUtilityTraceConfiguration.h:179
BOOL includeContent
Definition: AGSUtilityTraceConfiguration.h:109
BOOL validateConsistency
Definition: AGSUtilityTraceConfiguration.h:190
AGSUtilityTraversability * traversability
Definition: AGSUtilityTraceConfiguration.h:184
BOOL includeContainers
Definition: AGSUtilityTraceConfiguration.h:103
AGSUtilityTraceFilter * filter
Definition: AGSUtilityTraceConfiguration.h:74
NSArray< AGSUtilityTraceFunction * > * functions
Definition: AGSUtilityTraceConfiguration.h:81
instancetype utilityTraceConfiguration()
AGSUtilityDomainNetwork * domainNetwork
Definition: AGSUtilityTraceConfiguration.h:69
AGSUtilityNetworkAttribute * shortestPathNetworkAttribute
Definition: AGSUtilityTraceConfiguration.h:161
BOOL includeIsolatedFeatures
Definition: AGSUtilityTraceConfiguration.h:115
AGSUtilityTier * sourceTier
Definition: AGSUtilityTraceConfiguration.h:171
A mechanism to stop tracing when returning results. AGSUtilityTraceFilter objects do not stop travers...
Definition: AGSUtilityTraceFilter.h:48
Functions allow the computation of values during a network trace.
Definition: AGSUtilityTraceFunction.h:57
A set of options controlling what objects are evaluated or returned during a tracing operation....
Definition: AGSUtilityTraversability.h:50