Propagator properties

Summary

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

Learn more about using propagators

Properties

Property	Explanation	Data Type
networkAttributeName (Read Only)	The name of the network attribute used to filter the propagators condition.	String
networkAttributeOperator (Read Only)	The type of operator used for the propagation—for example, is equal to or is less than.	String
propagatedAttributeName (Read Only)	The name of the field that is used to store the calculated propagated values. The field type should match that of the field used for the networkAttributeName property.	String
substitutionAttributeName (Read Only)	The network attribute used for substitution.	String
tracePropagatorFunctionType (Read Only)	The type of function used for the function barrier—for example, propagated BitwiseAnd, Min, or Max.	String
value (Read Only)	The specific value of the network attribute or category used for the propagation.	Integer

Code sample

Utility network propagator properties example (stand-alone script)

This stand-alone Python script prints a report of 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

        # Propagator Properties
        print(" - Propagator Properties - ")
        for p in ust.propagators:
            # Try to get these properties if they exist; otherwise, print the empty list
            try:
                print(f"Network Attribute Name: {p.networkAttributeName}")
                print(f"Trace Propagator Function Type: {p.tracePropagatorFunctionType}")
                print(f"Network Attribute Filter Operator: {p.networkAttributeOperator}")
                print(f"Network Attribute Value: {p.value}")
                print(f"Propagated Attribute Name: {p.propagatedAttributeName}")
                print(f"Substitution Attribute Name: {p.substitutionAttributeName}")
            except:
                print("Skipped propagator properties. \n")