Show / Hide Table of Contents

Class UtilityTraceFilter

A mechanism to stop tracing when returning results. UtilityTraceFilter objects do not stop traversability to the controller.

Inheritance
System.Object
UtilityTraceFilter
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Esri.ArcGISRuntime.UtilityNetworks
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class UtilityTraceFilter
Remarks

Consider an upstream protective device trace. At first, you might try defining a UtilityCategoryComparison that looks for a Protective Device category and assigning this to Barriers. When you try to run an upstream trace using this configuration, it will probably fail. This is because traversability will stop at the first protective device, and the trace will be unable to find the subnetwork controller. The correct way to implement this trace is to assign UtilityCategoryComparison to the filter.

UtilityTraceFilter is set in the UtilityTraceConfiguration.

Constructors

Name Description
UtilityTraceFilter()

Initializes a new instance of the UtilityTraceFilter class.

Properties

Name Description
Barriers

Gets or sets a condition object specifying when to traverse a node or its subnodes.

BitsetNetworkAttribute

Gets or sets a UtilityNetworkAttribute that stores a bitset, and this bitset should be used to filter results.

FunctionBarriers

Gets a collection of UtilityTraceFunctionBarrier. If any of these objects evaluates to true, further traversal is terminated.

NearestNeighbor

Gets or sets a filter object specifying the next N features to be returned from the starting point.

Scope

Gets or sets a value that determines whether traversability criteria are evaluated on edges, junctions, or both.

Applies to

TargetVersions
.NET Standard 2.0100.8 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.8 - 200.7
Xamarin.Android100.8 - 100.15
Xamarin.iOS100.8 - 100.15
UWP100.8 - 200.7

Relevant samples

Perform valve isolation trace: Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.
In This Article
Back to top Copyright © 2022 Esri.