Package-level declarations

A utility network asset group. UtilityAssetGroup is the first-level categorization of an UtilityNetworkSource. (UtilityAssetType is the second-level categorization.) This class provides information about the UtilityAssetGroup, including the UtilityAssetType collection that is contained therein.

A utility network asset type. UtilityAssetType is the second-level categorization of an UtilityNetworkSource. (UtilityAssetGroup is the first-level categorization.)

A connectivity, containment, or structural attachment association. Associations are an integral part of network topology. Connectivity associations allow connectivity between two junctions that don't have geometric coincidence (are not in the same location). Structural attachment associations allow modeling equipment attached to structures. Containment associations allow modeling containment of features within other features. Network traces make use of associations. Associations are defined using two UtilityElement objects.

An enumeration of various association deletion behaviors. Determines the behavior that occurs when attempting to delete a feature which has containment or structural attachment associations to other features.

An enumeration of the various association roles. A feature's association role specifies how the feature can associate with other features, such as containment or attachment.

An enumeration of the various types of associations supported by the utility network.

An enumeration of the various comparisons to perform between an UtilityNetworkAttribute and a second UtilityNetworkAttribute or a specific value.

A category used to define a characteristic of an asset in a network. UtilityCategory can be used during tracing operations to define constraints or conditions based upon specific characteristics of asset types in the network.

A condition evaluating whether a particular UtilityCategory exists on a feature in the trace.

An enumeration of the various types of operators to use when evaluating the existence of an UtilityCategory on a network feature.

A domain network inside a utility network. Domain networks organize features in a utility network based on what utility service they provide, such as natural gas, water, electricity, or structural elements such as poles or conduits. Each utility network will have a single structure network and one or more domain networks for the actual utility services they provide.

An entity in a utility network that corresponds to a Feature. UtilityElement includes a reference to a Feature inside a utility network source, plus a terminal (if applicable). UtilityElement objects are used across the utility network API. Some places where they are used are to specify starting points and barriers for use with tracing, and returned as results from tracing.

A trace result set comprised of a collection of UtilityElement objects.

A trace result set comprised of a collection of UtilityTraceFunctionOutput objects.

The trace result comprised of a set of Geometry objects representing the network elements identified by the trace. The UtilityGeometryTraceResult exposes the geometry result with a property for each potential geometry type: Multipoint, Polyline, and Polygon. The geometry for these properties is the union of all geometries of that type returned by the trace. If the result does not include a certain geometry type, the corresponding property will be null.

An enumeration of the various types of minimum starting locations used in UtilityTraceParameters.

A set of predefined trace options that can be used by UtilityTraceParameters to simplify configuring and running a trace operation. Named trace configurations are created in the utility network and allow clients to perform trace analytics without needing to understand the data model. Applications can simply allow the user to choose from a set of named trace configurations that provide tracing capabilities. The set can be configured for different workflows, and a single application can be used by multiple customers and even across multiple problem domains.

The query parameters to use when searching for applicable named trace configuration objects. If none of the parameters are set the query will return all available named trace configurations. In the query the values in each property are combined using a logical OR and between each property a logical AND is used.

A filter set on UtilityTraceFilter.nearestNeighbor to return the next n features from the starting point.

Indicates the result of UtilityNearestNeighbor in the UtilityTraceConfiguration.filter in relation to its requested count.

A utility network. This is the central class for utility network schema information and tracing. UtilityNetwork follows the Loadable pattern. When it loads, it is populated with the utility network schema. This class provides methods to create UtilityElement objects for the UtilityNetwork.

A network attribute in a utility network. A Network Attribute is an attribute that is copied and stored in the topological index. The utility network tracing task can read and make decisions using network attributes that are stored directly in the topological index. Without needing to fetch the individual features to get their attributes, the topological index provides performance that is orders of magnitude faster.

A condition evaluating the value of an UtilityNetworkAttribute on nodes in the network, either to another UtilityNetworkAttribute or to a specific value.

An enumeration of the various UtilityNetworkAttribute data types. The UtilityNetworkAttribute objects in a topological index are limited to specific data types.

Defines the supported capabilities for a utility network. These non-configurable capabilities indicate which utility network operations are supported. They are dependent upon the utility network service capabilities or the contents of the geodatabase.

The metadata of a utility network. Includes metadata such as domain networks, network sources, and so on.

A network source in a utility network. Various sources of related information are associated to comprise the utility network. The most obvious sources are the structures and network features that are included with each domain network. Other sources are the set of associations and the system junctions.

An enumeration of the various network source types.

An enumeration of the various usage types of an UtilityNetworkSource. These values indicate how an UtilityNetworkSource is used in a utility network.

Defines the current state of a utility network. These read-only properties provide detailed information about the current state of the utility network topology. For more information about dirty areas and/or errors in the network, see UtilityNetwork.dirtyAreaTable.

Propagator objects allow a subset of UtilityNetworkAttribute values to propagate through a network while executing a trace. The propagated UtilityNetworkAttribute values can be tested to allow or disallow further traversal.

The function types that can be used with UtilityPropagator objects.

Defines a permissible association between features in a utility network. Network rules[https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/network-rules.htm] help maintain data integrity. They are imposed at the asset group, asset type, and terminal levels for the entire utility network to manage the correctness of assets in the network by allowing you to select which types of features can be connected or associated. A network rule supporting the type of association between features must exist or these features cannot be associated.

Specifies the type of features participating in a network rule. A rule element describes the type of features to which a network rule is applied.

An enumeration of the various types of network rules that determine permissible feature associations in a utility network.

The type of subnetwork controllers that are supported by a domain network.

A single terminal on a junction feature. Terminal objects can be obtained from UtilityTerminalConfiguration.terminals.

A utility network terminal configuration.

The set of flow paths between terminals for a given device configuration.

An enumeration of the directionality setting of terminals on a device.

Specifies a flow path between two UtilityTerminal objects.

Tiers demarcate a logical level within a network. For example, in an electric distribution network, there may be Subtransmission, Medium Voltage and Low Voltage tiers.

Tier groups provide an extra level of organization for tiers. For example, a gas network may be divided into two tier groups - Transmission and Distribution. Each of these tier groups would contain a set of tiers specific to that group. For example, Distribution Pressure and Distribution Isolation might be tiers within the Distribution tier group.

Specifies the type of topology that makes up an UtilityTier definition.

Describes the tier type of a domain network.

Combines two sub-expressions together using a logical AND operator.

The base class for a utility network traversability condition.

A trace condition that depends on the schema information in the Utility Network, such as the existence of an UtilityCategory on a node, or the value of an UtilityNetworkAttribute.

The set of utility network parameters that define elements of a trace or of a subnetwork. UtilityTraceConfiguration is set in the UtilityTraceParameters.

A mechanism to stop tracing when returning results. UtilityTraceFilter objects do not stop traversability to the controller. Consider an upstream protective device trace. At first, you might try defining an UtilityCategoryComparison that looks for a Protective Device category and assigning this to UtilityTraversability.barriers. When you try to run an upstream trace using this configuration, it will probably fail. This is because traversability will stop at the first protective device, and the trace will be unable to find the subnetwork controller. The correct way to implement this trace is to assign UtilityCategoryComparison to the filter.

Functions allow the computation of values during a network trace. Functions are evaluated at each applicable network element. The meaning of applicable varies depending on the Tracer. For an upstream trace, the functions are evaluated for each upstream element. For a downstream trace, the functions are evaluated for each element in the subnetwork. etc.

An UtilityTraceFunctionBarrier stops continued traversal when a comparison expression evaluates as true. An UtilityTraceFunctionBarrier performs a comparison expression between the current results of an UtilityTraceFunction and a given value. Remember that an UtilityTraceFunction references an UtilityNetworkAttribute and a calculation that is applied to it (Min, Max, Count, etc.) Once the comparison evaluates as true, network traversal stops.

An UtilityTraceFunctionOutput is comprised of an UtilityTraceFunction and its corresponding global result.

The type of function calculation to perform.

Two sub-expressions combined together using a logical OR operator.

Utility network trace parameters.

The base class for trace result objects.

An enumeration of the result types returned by a trace operation. The default is UtilityTraceResultType.Elements.

An enumeration of the various types of traces that may be performed with a utility network.

A set of options controlling what objects are evaluated or returned during a tracing operation. UtilityTraversability is set in the UtilityTraceConfiguration.

Used to specify whether traversability criteria are applied to junctions, edges, or both.