Skip to main content

Filter Function Barriers properties

Summary

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

Learn more about using barriers to restrict traversability

Properties

Property Explanation Data Type

functionType

(Read only)

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

String

networkAttributeName

(Read only)

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

String

networkAttributeOperator

(Read only)

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

String

useLocalValues

(Read only)

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

(Read only)

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

Integer

Code sample

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