Show / Hide Table of Contents

Class UtilityTraceConfiguration

An instance of this class represents a set of utility network parameters that define elements of a trace or of a subnetwork.

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

UtilityTraceConfiguration is set in the UtilityTraceParameters.

Constructors

Name Description
UtilityTraceConfiguration()

Initializes a new instance of the UtilityTraceConfiguration class.

Properties

Name Description
AllowIndeterminateFlow

Gets or sets a value indicating whether to allow tracing across network features with indeterminate flow or false to stop the traversal when indeterminate flow is encountered.

DomainNetwork

Gets or sets the UtilityDomainNetwork from which to start the trace.

Filter

Gets or sets the criteria that define the dynamic barriers for the trace.

Functions

Gets a collection of UtilityTraceFunction objects to compute while performing the trace.

IgnoreBarriersAtStartingPoints

Gets or sets a value indicating whether to ignore barriers at starting points.

IncludeBarriers

Gets or sets a value indicating whether to include barriers in the trace results or subnetwork.

IncludeContainers

Gets or sets a value indicating whether to include containment features in the trace results or subnetwork.

IncludeContent

Gets or sets a value indicating whether to include content in the trace results or subnetwork.

IncludeIsolatedFeatures

Gets or sets a value indicating whether to include isolated features in the trace results when used in conjunction with an isolation trace.

IncludeStructures

Gets or sets a value indicating whether to include structure features in the trace results or subnetwork.

IncludeUpToFirstSpatialContainer

Gets or sets a value indicating whether to include containment associations up to and including the first spatial container or false to include all containment associations.

OutputAssetTypes

Gets a collection of UtilityAssetType objects which specifies what to include in the trace results.

OutputCondition

Gets or sets a condition object which specifies what to include in the trace results.

Propagators

Gets a collection of UtilityPropagator objects to execute while performing the trace.

ShortestPathNetworkAttribute

Gets or sets the UtilityNetworkAttribute used to calculate the shortest path.

SourceTier

Gets or sets the UtilityTier that is used as the start of the trace.

TargetTier

Gets or sets the UtilityTier that is used to constrain the tiers returned by the Upstream and Downstream traces.

Traversability

Gets or sets the traversability conditions for the trace.

ValidateConsistency

Gets or sets a value indicating whether to validate network consistency as part of the trace operation.

ValidateLocatability

Gets or sets a value indicating whether to fail trace operations if non-spatial objects are encountered without the necessary containment, attachment, or connectivity association to a spatial object, or false to allow tracing of those non-spatial objects.

Applies to

TargetVersions
.NET Standard 2.0100.7 - 200.2
.NET 6.0100.13 - 200.2
.NET 6.0 Windows100.13 - 200.2
.NET 6.0 Android200.0 - 200.2
.NET 6.0 iOS200.0 - 200.2
.NET Framework100.7 - 200.2
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Android100.7 - 100.15
iOS100.7 - 100.15
UWP100.7 - 200.2

Relevant samples

Configure subnetwork trace: Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
Perform valve isolation trace: Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.
Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.
In This Article
Back to top Copyright © 2022 Esri.