Class UtilityTraceFilter
A mechanism to stop tracing when returning results. UtilityTraceFilter objects do not stop traversability to the controller.
Inheritance
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
Target | Versions |
---|---|
.NET Standard 2.0 | 100.8 - 200.6 |
.NET | 100.13 - 200.6 |
.NET Windows | 100.13 - 200.6 |
.NET Android | 200.0 - 200.6 |
.NET iOS | 200.0 - 200.6 |
.NET Framework | 100.8 - 200.6 |
Xamarin.Android | 100.8 - 100.15 |
Xamarin.iOS | 100.8 - 100.15 |
UWP | 100.8 - 200.6 |