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.9
Since: Esri.ArcGISRuntime 100.7
Inherits:

Object

Properties

Signals

Detailed Description

UtilityTraceConfiguration is set in the UtilityTraceParameters.

Property Documentation

domainNetwork : UtilityDomainNetwork

The UtilityDomainNetwork from which to start the trace.

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


The criteria that define the dynamic barriers for the trace.

This property was introduced in Esri.ArcGISRuntime 100.8.


A collection of UtilityTraceFunction objects to compute while performing the trace.

Each UtilityTraceFunction returns a UtilityTraceFunctionOutput in the UtilityFunctionTraceResult.

This property was introduced in Esri.ArcGISRuntime 100.9.


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.


includeIsolatedFeatures : bool

Whether to include isolated features in the trace results when used in conjunction with an isolation trace.

The default is false.

This property was introduced in Esri.ArcGISRuntime 100.8.


includeStructures : bool

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

The default is false.


outputAssetTypes : UtilityAssetTypeListModel

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

Only elements that belong to this UtilityAssetType are included in the trace result. This property is independent of asset types in the UtilityTraceConfiguration::filter. This is applied after all other tracing calculations, including traversal, filters, and function calculation. If this is empty and UtilityTraceConfiguration::outputCondition is null, all elements are returned. Otherwise, elements which match either of these criteria are returned.

This property was introduced in Esri.ArcGISRuntime 100.9.


outputCondition : UtilityTraceCondition

A condition object which specifies what to include in the trace results.

Only elements that satisfy this UtilityTraceCondition are included in the trace result. This condition may perform comparisons against network attributes (UtilityNetworkAttributeComparison) and categories (UtilityCategoryComparison), or both (UtilityTraceAndCondition, UtilityTraceOrCondition). This property is independent of barriers in the UtilityTraceConfiguration::traversability or UtilityTraceConfiguration::filter. This is applied after all other tracing calculations, including traversal, filters, and function calculation. If this is null and UtilityTraceConfiguration::outputAssetTypes is empty, all elements are returned. Otherwise, elements which match either of these criteria are returned.

This property was introduced in Esri.ArcGISRuntime 100.9.


shortestPathNetworkAttribute : UtilityNetworkAttribute

The UtilityNetworkAttribute used to calculate the shortest path.

The shortest path may depend on some other numeric weight, such as cost or difficulty, rather than the shortest distance calculated from shape length.

This property was introduced in Esri.ArcGISRuntime 100.9.


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.

Note: The corresponding handler is onDomainNetworkChanged.


filterChanged()

Emitted when the filter property changes.

Note: The corresponding handler is onFilterChanged.

This signal was introduced in Esri.ArcGISRuntime 100.8.


ignoreBarriersAtStartingPointsChanged()

Emitted when the ignoreBarriersAtStartingPoints property changes.

Note: The corresponding handler is onIgnoreBarriersAtStartingPointsChanged.


includeBarriersChanged()

Emitted when the includeBarriers property changes.

Note: The corresponding handler is onIncludeBarriersChanged.


includeContainersChanged()

Emitted when the includeContainers property changes.

Note: The corresponding handler is onIncludeContainersChanged.


includeContentChanged()

Emitted when the includeContent property changes.

Note: The corresponding handler is onIncludeContentChanged.


includeIsolatedFeaturesChanged()

Emitted when the includeIsolatedFeatures property changes.

Note: The corresponding handler is onIncludeIsolatedFeaturesChanged.

This signal was introduced in Esri.ArcGISRuntime 100.8.


includeStructuresChanged()

Emitted when the includeStructures property changes.

Note: The corresponding handler is onIncludeStructuresChanged.


outputConditionChanged()

Emitted when the outputCondition property changes.

Note: The corresponding handler is onOutputConditionChanged.

This signal was introduced in Esri.ArcGISRuntime 100.9.


shortestPathNetworkAttributeChanged()

Emitted when the shortestPathNetworkAttribute property changes.

Note: The corresponding handler is onShortestPathNetworkAttributeChanged.

This signal was introduced in Esri.ArcGISRuntime 100.9.


sourceTierChanged()

Emitted when the sourceTier property changes.

Note: The corresponding handler is onSourceTierChanged.


targetTierChanged()

Emitted when the targetTier property changes.

Note: The corresponding handler is onTargetTierChanged.


traversabilityChanged()

Emitted when the traversability property changes.

Note: The corresponding handler is onTraversabilityChanged.


validateConsistencyChanged()

Emitted when the validateConsistency property changes.

Note: The corresponding handler is onValidateConsistencyChanged.



Feedback on this topic?