Skip to main content

Update Subnetwork Trace Configuration properties

Resumen

The properties below are returned by the updateSubnetworkTraceConfiguration object when using Describe on a utility network.

These properties describe the trace configuration used when a subnetwork is updated.

Learn more about configuring a trace

Propiedades

Propiedad Explicación Tipo de datos

conditionBarriers

(Solo lectura)

The conditionBarriers object. This object can be used to retrieve properties of the condition barriers set for the trace configuration.

Object

diagramTemplateName

(Solo lectura)

The name of the diagram template used for the trace configuration.

String

domainNetworkName

(Solo lectura)

The name of the domain network.

String

filterBarriers

(Solo lectura)

The filterBarriers object. This object can be used to retrieve properties of the filter barriers set for the trace configuration.

Object

filterBitsetNetworkAttributeName

(Solo lectura)

The name of the network attribute that can be used to filter by bitset.

String

filterFunctionBarriers

(Solo lectura)

The filterFunctionBarriers object. This object can be used to retrieve properties of the filter function barriers set for the trace configuration.

Object

filterScope

(Solo lectura)

The traversability that is enforced for a specific category—for example, both junctions and edges, junctions only, or edges only.

String

functionBarriers

(Solo lectura)

The functionBarriers object. This object can be used to retrieve properties of the function barriers set for the trace configuration.

Object

functions

(Solo lectura)

The functions object. This object can be used to retrieve properties of the functions set for the trace configuration.

Object

includeBarriers

(Solo lectura)

Whether the trace is configured to include barrier features in the trace results.

  • True—The trace is configured to include barriers.

  • False—The trace is not configured to include barriers.

Boolean

includeContainers

(Solo lectura)

Whether the trace is configured to include container features in the trace results.

  • True—The trace is configured to include containers.

  • False—The trace is not configured to include containers.

Boolean

includeContent

(Solo lectura)

Whether the trace is configured to include content in containers in the trace results.

  • True—The trace is configured to include content.

  • False—The trace is not configured to include content.

Boolean

includeStructures

(Solo lectura)

Whether the trace is configured to include structure features in the trace results.

  • True—The trace is configured to include structures.

  • False—The trace is not configured to include structures.

Boolean

nearestNeighbor

(Solo lectura)

The nearestNeighbor object. This object can be used to retrieve properties of the nearest neighbor set for the trace configuration.

Object

outputConditions

(Solo lectura)

The outputConditions object. This object can be used to retrieve properties of the output conditions set for the trace configuration.

Object

outputFilters

(Solo lectura)

The outputFilters object. This object can be used to retrieve properties of the output filters set for the trace configuration.

Object

propagators

(Solo lectura)

The propagators object. This object can be used to retrieve properties of the propagators set for the trace configuration.

Object

shortestPathNetworkAttributeName

(Solo lectura)

The name of the network attribute used to calculate the shortest path.

String

targetTierName

(Solo lectura)

The name of the target tier for which the starting tier flows toward.

String

tierName

(Solo lectura)

The name of the tier to start the trace.

String

traversabilityScope

(Solo lectura)

The traversability that is enforced—for example, both junctions and edges, junctions only, or edges only.

String

validateConsistency

(Solo lectura)

Whether the trace is configured to validate consistency in trace results.

  • True—If any dirty areas are encountered during the trace, a warning is returned.

  • False—No warning will be returned if dirty areas are encountered during the trace.

Boolean

Muestra de código

Utility network update subnetwork trace configuration properties example (stand-alone script)

This stand-alone Python script prints a report of some utility network properties.

# Import required modules
import arcpy

# Describe functions on a Utility Network
UN = "C:\\Projects\\MyProject\\unowner.sde\\Naperville.UNOWNER.Naperville\\Naperville.UNOWNER.Naperville"
d = arcpy.Describe(UN)

# Domain Network properties
domnets = d.domainNetworks

# For each domain network in the utility network
for dom in domnets:
    print(f"Domain Network Name: {dom.domainNetworkName}")

    # For each tier in the domain network
    for tier in dom.tiers:
        print(f"Tier Name: {tier.name}")

        # Update Subnetwork Trace Configuration Properties
        print(" -- Update Subnetwork Trace Properties -- ")
        ust = tier.updateSubnetworkTraceConfiguration
        print(f"Include Containers: {ust.includeContainers}")
        print(f"Include Content: {ust.includeContent}")
        print(f"Include Structures: {ust.includeStructures}")
        print(f"Include Barriers: {ust.includeBarriers}")
        print(f"Validate Consistency: {ust.validateConsistency}")
        print(f"Validate Locatability: {ust.validateLocatability}")
        print(f"Include Isolated: {ust.includeIsolated}")
        print(f"Ignore Barriers at Starting Points: {ust.ignoreBarriersAtStartingPoints}")
        print(f"Include Up To First Spatial Container: {ust.includeUpToFirstSpatialContainer}")
        print(f"Allow Indeterminate Flow: {ust.allowIndeterminateFlow}")
        print(f"Domain Network Name: {ust.domainNetworkName}")
        print(f"Tier Name: {ust.tierName}")
        print(f"Target Tier Name: {ust.targetTierName}")
        print(f"Subnetwork Name: {ust.subnetworkName}")
        print(f"Diagram Template Name: {ust.diagramTemplateName}")
        print(f"Shortest Path Network Attribute Name: {ust.shortestPathNetworkAttributeName}")
        print(f"Filter Bitset Network Attribute Name: {ust.filterBitsetNetworkAttributeName}")
        print(f"Traversability Scope: {ust.traversabilityScope}")
        print(f"Filter Scope: {ust.filterScope} \n")