Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityTraceConfiguration QML Type

The set of utility network parameters that define elements of a trace or of a subnetwork. More...

Import Statement: import Esri.ArcGISRuntime 100.7
Since: Esri.ArcGISRuntime 100.7
Inherits:

Object

Properties

Signals

Detailed Description

Property Documentation

domainNetwork : UtilityDomainNetwork

The UtilityDomainNetwork from which to start the trace.

The UtilityDomainNetwork property is required and only used with subnetwork-based traces (UtilityTraceType.Subnetwork, UtilityTraceType.Upstream, and so on).


ignoreBarriersAtStartingPoints : bool

Whether to ignore barriers at starting points.

The default is false.

One example of how this can be used is with an upstream protective device trace. The first call to the trace will return the first upstream device that meets the protective device criteria. To find the next device upstream, you would set a starting point on the device returned by the first trace. With IgnoreBarriersAtStartingPoints set to false, this second trace would immediately stop at the starting point, since it meets the trace termination criteria. Setting this option to true will allow the trace to ignore the starting point, and continue to the subsequent device upstream.


includeBarriers : bool

Whether to include barriers in the trace results or subnetwork.

The default is true.


includeContainers : bool

Whether to include containment features in the trace results or subnetwork.

The default is false.


includeContent : bool

Whether to include content in the trace results or subnetwork.

The default is false.


includeStructures : bool

Whether to include structure features in the trace results or subnetwork.

The default is false.


sourceTier : UtilityDomainNetwork

The UtilityTier that is used as the start of the trace.

This property is only used with subnetwork-based traces (such as subnetwork upstream). If UtilityTraceConfiguration.domainNetwork represents a partitioned network, this property is optional. If not null, the trace routines will perform an additional check to validate that the starting points and barriers belong to this tier. If UtilityTraceConfiguration.domainNetwork represents a hierarchical network, this property is required. Since rows in hierarchical networks can belong to multiple tiers, this property tells the subnetwork tracer which tier to use for tracing.


targetTier : UtilityDomainNetwork

The UtilityTier that is used to constrain the tiers returned by the upstream and downstream traces.

This property is optional. If null, the upstream and downstream traces will stop in the current tier. If a target tier is specified, the trace will continue upstream or downstream into the specified tier (inclusive).


traversability : UtilityTraversability

The traversability conditions for the trace.


validateConsistency : bool

Whether to validate network consistency as part of the trace operation.

If set to true, trace operations will fail if dirty areas are encountered during the trace. The default is true.


Signal Documentation

domainNetworkChanged()

Emitted when the domainNetwork property changes.


ignoreBarriersAtStartingPointsChanged()

Emitted when the ignoreBarriersAtStartingPoints property changes.


includeBarriersChanged()

Emitted when the includeBarriers property changes.


includeContainersChanged()

Emitted when the includeContainers property changes.


includeContentChanged()

Emitted when the includeContent property changes.


includeStructuresChanged()

Emitted when the includeStructures property changes.


sourceTierChanged()

Emitted when the sourceTier property changes.


targetTierChanged()

Emitted when the targetTier property changes.


traversabilityChanged()

Emitted when the traversability property changes.


validateConsistencyChanged()

Emitted when the validateConsistency property changes.



Feedback on this topic?