UtilityTraceConfiguration

Creates an UtilityTraceConfiguration with default values.

True to allow tracing across network features with indeterminate flow or false to stop the traversal when indeterminate flow is encountered. Indeterminate flow can occur when there is a loop in the network where traversal in either direction could be used to find the subnetwork controller (both upstream and downstream at the same time, in other words). This property is useful for upstream, downstream, or isolation traces where flow direction for the subnetwork is determined. This option is only applicable with Utility Network versions 5 or higher. The default is true.

The UtilityDomainNetwork from which to start the trace. The UtilityDomainNetwork property is required and only used with subnetwork-based traces (UtilityTraceType.Subnetwork, UtilityTraceType.Upstream, etc.).

The criteria that define the dynamic barriers for the trace.

A collection of UtilityTraceFunction objects to compute while performing the trace. Each UtilityTraceFunction returns an UtilityTraceFunctionOutput in the UtilityFunctionTraceResult.

Indicates 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.

Whether to include barriers in the trace results or subnetwork. The default is true.

Whether to include containment features in the trace results or subnetwork. The default is false.

Whether to include content in the trace results or subnetwork. The default is false.

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

Whether to include structure features in the trace results or subnetwork. The default is false.

True to include containment associations up to and including the first spatial container or false to include all containment associations. This property depends on the UtilityTraceConfiguration.includeContainers property and is ignored if it's false. If no spatial containers are encountered but non-spatial containers are present for a given network element, all non-spatial containers are included in the results. This is typically used with telecommunications networks with multiple levels of containment with non-spatial objects (for example, splice points within a splice tray within a splice container). The default is false.

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.

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.

A collection of UtilityPropagator objects to execute while performing the trace. Propagator objects allow a subset of UtilityNetworkAttribute values to propagate through a network while executing a trace. For example, in phase propagation, open devices along the network will restrict some phases from continuing along the trace. Propagators only apply to subnetwork-based traces. (UtilityTraceType.Upstream, UtilityTraceType.Downstream, and so on).

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.

The UtilityTier that is used as the start of the trace. This property is only used with subnetwork-based traces (subnetwork upstream, etc.). 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.

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).

The traversability conditions for the trace.

Indicates 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.

True 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. Locatability is determined by whether a non-spatial object has implied geometry. Geometry is implied for non-spatial objects if they are associated via containment (possibly multiple levels) with spatial features. This is typically used with telecommunications networks with many non-spatial objects. For example, if a splice tray (non-spatial junction object) is contained within a splice container (assembly feature), then it would be considered locatable. This property is only applicable for Utility Network versions 4 or later. The default is false.