The set of utility network parameters that define elements of a trace or of a subnetwork. AGSUtilityTraceConfiguration
is set in the AGSUtilityTraceParameters
object.
- Since
- 100.7
◆ init
◆ utilityTraceConfiguration
+ (instancetype) utilityTraceConfiguration |
|
|
|
◆ domainNetwork
The AGSUtilityDomainNetwork
object from which to start the trace. The AGSUtilityDomainNetwork
object is required and only used with subnetwork-based traces (AGSUtilityTraceTypeSubnetwork
, AGSUtilityTraceTypeUpstream
, etc.)
- Since
- 100.7
◆ filter
The criteria that define the dynamic barriers for the trace.
- Since
- 100.8
◆ functions
◆ ignoreBarriersAtStartingPoints
- (BOOL) ignoreBarriersAtStartingPoints |
|
readwritenonatomicassign |
Indicates whether to ignore barriers at starting points. The default is NO
. 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 NO
, this second trace would immediately stop at the starting point, since it meets the trace termination criteria. Setting this option to YES
will allow the trace to ignore the starting point, and continue to the subsequent device upstream.
- Since
- 100.7
◆ includeBarriers
Whether to include barriers in the trace results or subnetwork. The default is YES
.
- Since
- 100.7
◆ includeContainers
- (BOOL) includeContainers |
|
readwritenonatomicassign |
Whether to include containment features in the trace results or subnetwork. The default is NO
.
- Since
- 100.7
◆ includeContent
Whether to include content in the trace results or subnetwork. The default is NO
.
- Since
- 100.7
◆ includeIsolatedFeatures
- (BOOL) includeIsolatedFeatures |
|
readwritenonatomicassign |
Whether to include isolated features in the trace results when used in conjunction with an isolation trace. The default is NO
.
- Since
- 100.8
◆ includeStructures
- (BOOL) includeStructures |
|
readwritenonatomicassign |
Whether to include structure features in the trace results or subnetwork. The default is NO
.
- Since
- 100.7
◆ outputAssetTypes
◆ outputCondition
◆ propagators
An array of AGSUtilityPropagator
objects to execute while performing the trace. Propagator objects allow a subset of AGSUtilityNetworkAttribute
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. (AGSUtilityTraceTypeUpstream
, AGSUtilityTraceTypeDownstream
, and so on).
- Since
- 100.7
◆ shortestPathNetworkAttribute
The AGSUtilityNetworkAttribute
object 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.
- Since
- 100.9
◆ sourceTier
The AGSUtilityTier
object that is used as the start of the trace. This property is only used with subnetwork-based traces (subnetwork upstream, etc.). If the AGSUtilityTraceConfiguration::domainNetwork
property represents a partitioned network, this property is optional. If not nil
, the trace routines will perform an additional check to validate that the starting points and barriers belong to this tier. If the AGSUtilityTraceConfiguration::domainNetwork
property 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.
- Since
- 100.7
◆ targetTier
The AGSUtilityTier
object that is used to constrain the tiers returned by the upstream and downstream traces. This property is optional. If nil
, 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).
- Since
- 100.7
◆ traversability
The traversability conditions for the trace.
- Since
- 100.7
◆ validateConsistency
- (BOOL) validateConsistency |
|
readwritenonatomicassign |
Indicates whether to validate network consistency as part of the trace operation. If set to YES
, trace operations will fail if dirty areas are encountered during the trace. The default is YES
.
- Since
- 100.7