Trace parameters

Trace parameters specify how the trace analysis proceeds across the utility network. Essential trace parameters, described in this section, include:

Trace type

Use one of the supported traces (such as upstream, downstream, subnetwork, and so on) to create the parameters with starting locations. Refer to the Trace a utility network overview for a description of the supported trace types.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
// Build trace parameters
UtilityTraceParameters* traceParams = new UtilityTraceParameters(
  UtilityTraceType::Downstream, /* QList<UtilityElement*> */ startingLocations, this);

Trace locations

A trace location can be one of the following:

  • Starting point
  • Barrier
  • Filter barrier

All of the traces except shortest path require at least one starting point. Barriers are optional. A filter barrier is only required for an isolation trace when no trace filter barrier condition was specified. The respective collections for these contain UtilityElement objects that can be created as explained in the Analyze your network topic.

Once you have a utility element, you can add it to the collection that fits its purpose.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
    // Get the QList of utility elements from the utility trace parameters for starting locations
    QList<UtilityElement*> startinglocationsUtilityElements = utilityTraceParameters->startingLocations();

    // Add the starting location utility element to the QList of utility elements
    startinglocationsUtilityElements.append(startinglocationUtilityElement);

    // Get the QList of utility elements from the utility trace parameters for barriers
    QList<UtilityElement*> barrierUtilityElements = utilityTraceParameters->barriers();

    // Add the barrier utility element to the QList of utility elements
    barrierUtilityElements.append(barrierUtilityElement);

    // Get the QList of utility elements from the utility trace parameters for filter barriers
    QList<UtilityElement*> filterbarrierUtilityElements = utilityTraceParameters->filterBarriers();

    // Add the filter barrier utility element to the QList of utility elements
    filterbarrierUtilityElements.append(filterbarrierUtilityElement);

Trace configuration

A trace configuration allows you to do things like:

  • Stop the trace at protective devices if they are open. For example, the flow of electricity in a network will be stopped if a fuse is open.
  • Control the types of features traced. For example, trace only pipes with a diameter greater than six inches.
  • Filter the types of features returned as trace results. For example, only return elements identified by the trace that represent wooden poles.
  • Define functions to run calculations on network attributes associated with traced features. For example, the sum of the length of all the wire traced. Several functions can be specified for a trace.

See the Trace configuration topic for more information.

Below is an example of trace configuration for isolation trace.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
    // Create a utility trace configuration
    UtilityTraceConfiguration* utilityTraceConfiguration = new UtilityTraceConfiguration(this);

    // Get the utility network definition from the utility network
    UtilityNetworkDefinition* utilityNetworkDefinition = utilityNetwork->definition();

    // Get the utility domain network from the utility network definition for the "Water" type
    UtilityDomainNetwork* utilityDomainNetwork = utilityNetworkDefinition->domainNetwork("Water");

    // Set the domain network on the utility trace configuration
    utilityTraceConfiguration->setDomainNetwork(utilityDomainNetwork);

    // Get the utility tier from the utility domain network for the "Water Pressure" type
    UtilityTier* utilityTier = utilityDomainNetwork->tier("Water Pressure");

    // Set the source tier on the utility trace configuration
    utilityTraceConfiguration->setSourceTier(utilityTier);

    // Create a utility trace filter
    UtilityTraceFilter* utilityTraceFilter = new UtilityTraceFilter(this);

    // Create a utility category comparison with an "Isolating" type and a utility category comparision
    // operator of 'Exists'
    UtilityCategoryComparison* utilityCategoryComparison = new UtilityCategoryComparison(
        "Isolating", UtilityCategoryComparisonOperator::Exists, this);

    // Set the utility category comparison on the utility trace filter
    utilityTraceFilter->setBarriers(utilityCategoryComparison);

    // Set the utility trace configuration on the utility trace parameters
    utilityTraceParameters->setTraceConfiguration(utilityTraceConfiguration);

Trace results

You can add a variety of trace result types (UtilityTraceResultType) to the UtilityTraceParameters result types collection to define the results returned from a trace. At least one type of trace result is required, but you can request several.

  • Element results—Provide information about the individual network features. This is the default result returned.
  • Function results—Calculate values based on network attributes. Note that this type of result requires your trace configuration to include function inputs.
  • Geometry results—Allow you to display the results on the map. This result type is supported by ArcGIS Enterprise 10.8.1 or later and for mobile geodatabase, you need ArcGIS Maps SDKs for Native Apps version 200.1 or later.

See the Work with trace results topic for more information about trace results.

The following example shows creating a trace function, including it with the trace configuration, and requesting its result in the output.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
    // Get the utility network definition from the utility network
    UtilityNetworkDefinition* utilityNetworkDefinition = utilityNetwork->definition();

    // Get the utility network attribute from the utility network definition for the "Shape length" type
    UtilityNetworkAttribute* utilityNetworkAttribute = utilityNetworkDefinition->networkAttribute("Shape length");

    // Create a utility trace function with a utility trace function type of 'Add' and the utility
    // network attribute
    UtilityTraceFunction* utilityTraceFunction = new UtilityTraceFunction(
        UtilityTraceFunctionType::Add, utilityNetworkAttribute, this);

    // Get the utility trace configuration from the utility trace parameters
    UtilityTraceConfiguration* utilityTraceConfiguration = utilityTraceParameters->traceConfiguration();

    // Get the utility trace functional list model from the utility trace configuration
    UtilityTraceFunctionListModel* utilityTraceFunctionListModel = utilityTraceConfiguration->functions();

    // Add the utility trace function to the utility trace function list model
    utilityTraceFunctionListModel->append(utilityTraceFunction);

    // Get the QList of utility trace result types from the utility trace parameters
    QList<UtilityTraceResultType> utilityTraceResultTypes = utilityTraceParameters->resultTypes();

    // Add the utility trace result type of 'FunctionOutputs' to the utility trace result types
    utilityTraceResultTypes.append(UtilityTraceResultType::FunctionOutputs);

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.