Domain Network properties

Summary

The following properties are returned by the domainNetworks object in a utility network.

Learn more about domain networks

Properties

PropertyExplanationData Type
creationTime
(Read Only)

The date and time that the domain network was created.

DateTime
domainNetworkAliasName
(Read Only)

If the domain network has an alias, this property will return the domain network alias name.

String
domainNetworkID
(Read Only)

The ID of the network domain.

Integer
domainNetworkName
(Read Only)

The name of the domain network.

String
edgeSources
(Read Only)

The domain network edgeSources object. This object can be used to retrieve information about the edge sources in the domain network.

Object
isStructureNetwork
(Read Only)

Whether the domain network is a structure network.

  • True—The domain network is a structure network
  • False—The domain network is not a structure network.

Boolean
junctionSources
(Read Only)

The domain network junctionSources object. This object can be used to retrieve information about the junction sources in the domain network.

Object
releaseNumber
(Read Only)

The release number of when the domain network was created.

Integer
subnetworkControllerType
(Read Only)

The subnetwork controller type for the domain network—for example, source or sink.

String
subnetworkLabelFieldName
(Read Only)

The name of the field used for subnetwork labels in the domain network.

String
subnetworkTableName
(Read Only)

The name of the subnetwork table for the domain network.

String
tierDefinition
(Read Only)

The tier definition for the domain network—for example, hierarchical or partitioned.

String
tierGroups
(Read Only)

The domain network tierGroups object. This object can be used to retrieve information about the tier groups of the domain network. This property is only available for hierarchical tier definitions.

Object
tiers
(Read Only)

The domain network tiers object. This object can be used to retrieve information about the tiers in the domain network.

Object

Code sample

Utility network domain network properties example (stand-alone script)

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

'''****************************************************************************
Name:        DescribeUtilityNetworkProperties.py
Description: This script reports the properties of a utility network
Created by:  Esri
****************************************************************************'''

# Import required modules
import arcpy

# Describe function on a Utility Network
UN = "C:\\MyProject\\databaseConn.sde\\mygdb.USER1.Naperville\\mygdb.USER1.ElectricNetwork"
d = arcpy.Describe(UN)

# Domain Network properties
domnets = d.domainNetworks
for dom in domnets:
    print("*** - Domain Network properties - ***")
    print(f"Creation Time: {dom.creationTime}")
    print(f"Release Number: {dom.releaseNumber}")
    print(f"Is Structure Network: {dom.isStructureNetwork}")
    print(f"Domain Network ID: {dom.domainNetworkId}")
    print(f"Domain Network Name: {dom.domainNetworkName}")
    print(f"Domain Network Alias Name: {dom.domainNetworkAliasName}")
    print(f"Subnetwork Table Name: {dom.subnetworkTableName}")
    print(f"Subnetwork Label Field Name: {dom.subnetworkLabelFieldName}")
    print(f"Tier Definition: {dom.tierDefinition}")
    print(f"Subnetwork Controller Type: {dom.subnetworkControllerType} \n")
    
    # Tier Group properties
    for tierGroup in dom.tierGroups:
        print(f"*** - Tier Group properties - ***")
        print(f"Tier Group Name: {tierGroup.name}")
        print(f"Tier Group Creation Time: {tierGroup.creationTime}")