Filter Function Barriers properties

Synthèse

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

Learn more about using barriers to restrict traversability

Propriétés

PropriétéExplicationType de données
functionType
(Lecture seule)

The type of function used for the filter function barrier—for example, the minimum, maximum, or count.

String
networkAttributeName
(Lecture seule)

The name of the network attribute used for the filter function barrier condition.

String
networkAttributeOperator
(Lecture seule)

The type of operator used for the filter function barrier—for example, is equal to or is less than.

String
useLocalValues
(Lecture seule)

Whether the filter function barrier is using the local values for the trace.

  • True—The filter function barrier is using local values.
  • False—The filter function barrier is using global values.

Boolean
value
(Lecture seule)

The specific value of the network attribute or category used for the filter function barrier.

Integer

Exemple de code

Utility network filter function barriers 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     
        ust = tier.updateSubnetworkTraceConfiguration

        # Filter Function Barrier Properties
        print(" - Filter Function Barrier Properties - ")
        for ffb in ust.filterFunctionBarriers:
            try:
                print(f"Name: {ffb.networkAttributeName}")
                print(f"Type: {ffb.functionType}")
                print(f"Operator: {ffb.networkAttributeOperator}")
                print(f"Value: {ffb.value}")
                print(f"Use Local Values: {ffb.useLocalValues} \n")
            except:
                print("Skipped filter function properties. \n")