Skip To Content ArcGIS for Developers Sign In Dashboard

<UtilityNetworkTypes.h> - Utility Network Enums

Collection of Utility Network enumerations. More...

Header: #include <UtilityNetworkTypes.h>

Types

enum class UtilityAssociationRole { None, Container, Structure }
enum class UtilityAssociationType { Connectivity, Containment, Attachment }
enum class UtilityAttributeComparisonOperator { Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, …, DoesNotIncludeAny }
enum class UtilityCategoryComparisonOperator { Exists, DoesNotExist }
enum class UtilityNetworkAttributeDataType { Integer, Float, Double, Boolean }
enum class UtilityNetworkSourceType { Junction, Edge }
enum class UtilityNetworkSourceUsageType { Device, Junction, Line, Assembly, SubnetLine, …, StructureEdgeObject }
enum class UtilityPropagatorFunctionType { BitwiseAnd, Max, Min }
enum class UtilitySubnetworkControllerType { None, Source, Sink }
enum class UtilityTerminalDirectionality { Unidirectional, Bidirectional }
enum class UtilityTierTopologyType { Radial, Mesh }
enum class UtilityTierType { Hierarchical, Partitioned }
enum class UtilityTraceConditionType { UtilityNetworkAttributeComparison, UtilityCategoryComparison, UtilityTraceAndCondition, UtilityTraceOrCondition }
enum class UtilityTraceFunctionType { Add, Average, Count, Max, Min, Subtract }
enum class UtilityTraceResultObjectType { UtilityElementTraceResult, UtilityFunctionTraceResult, UtilityGeometryTraceResult }
enum class UtilityTraceResultType { Elements, FunctionOutputs, Geometry }
enum class UtilityTraceType { Connected, Subnetwork, Upstream, Downstream, Isolation, …, ShortestPath }
enum class UtilityTraversabilityScope { JunctionsAndEdges, Junctions, Edges }

Detailed Description

Type Documentation

enum class UtilityAssociationRole

Enumerates the various association roles

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

UtilityAssociationRole can be one of:

ConstantValueDescription
UtilityAssociationRole::None0These are features that are neither a container nor a structure but can connect to or be contained by other structures.
UtilityAssociationRole::Container1Features of this asset type can contain other features as contents.
UtilityAssociationRole::Structure2Features of this asset type can have other features attached to them.

This enum was introduced or modified in Esri::ArcGISRuntime 100.6.

enum class UtilityAssociationType

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

UtilityAssociationType can be one of:

ConstantValueDescription
UtilityAssociationType::Connectivity1The association represents connectivity between two junctions.
UtilityAssociationType::Containment2The association represents containment of one Esri::ArcGISRuntime::UtilityElement within another.
UtilityAssociationType::Attachment3The association represents a structural attachment.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityAttributeComparisonOperator

Enumerates the various comparison operators for utility attributes

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

UtilityAttributeComparisonOperator can be one of:

ConstantValueDescription
UtilityAttributeComparisonOperator::Equal0Tests whether an attribute is equal to another attribute or a specific value.
UtilityAttributeComparisonOperator::NotEqual1Tests whether an attribute is not equal to another attribute or a specific value.
UtilityAttributeComparisonOperator::GreaterThan2Tests whether an attribute is greater than another attribute or a specific value.
UtilityAttributeComparisonOperator::GreaterThanEqual3Tests whether an attribute is greater than or equal to another attribute or a specific value.
UtilityAttributeComparisonOperator::LessThan4Tests whether an attribute is less than another attribute or a specific value.
UtilityAttributeComparisonOperator::LessThanEqual5Tests whether an attribute is less than or equal to another attribute or a specific value.
UtilityAttributeComparisonOperator::IncludesTheValues6Tests whether an attribute includes all the values specified in another attribute or the particular values contained in the condition.
UtilityAttributeComparisonOperator::DoesNotIncludeTheValues7Tests whether an attribute does not include all of the values specified in another attribute or the particular values in the condition.
UtilityAttributeComparisonOperator::IncludesAny8Tests whether an attribute includes any of the values specified in another attribute or the particular values contained in the condition.
UtilityAttributeComparisonOperator::DoesNotIncludeAny9Tests whether an attribute does not include any of the values specified in another attribute or the particular values in the condition.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityCategoryComparisonOperator

Enumerates the various comparison operators for utility categories

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

UtilityCategoryComparisonOperator can be one of:

ConstantValueDescription
UtilityCategoryComparisonOperator::Exists0Evaluate that the UtilityCategory exists on a network feature.
UtilityCategoryComparisonOperator::DoesNotExist1Evaluate that the UtilityCategory does not exist on a network feature.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityNetworkAttributeDataType

Enumerates the various network attribute data types

The UtilityNetworkAttribute objects in a topological index are limited to specific data types.

UtilityNetworkAttributeDataType can be one of:

ConstantValueDescription
UtilityNetworkAttributeDataType::Integer0A signed 64-bit integer value.
UtilityNetworkAttributeDataType::Float1A floating point value.
UtilityNetworkAttributeDataType::Double2A double precision floating point value.
UtilityNetworkAttributeDataType::Boolean3A Boolean value.

This enum was introduced or modified in Esri::ArcGISRuntime 100.6.

enum class UtilityNetworkSourceType

Enumerates the various utility network source types

UtilityNetworkSourceType can be one of:

ConstantValueDescription
UtilityNetworkSourceType::Junction0The network source references junctions in a feature class or table.
UtilityNetworkSourceType::Edge1The network source references edges in a feature class or table.

This enum was introduced or modified in Esri::ArcGISRuntime 100.6.

enum class UtilityNetworkSourceUsageType

Enumerates the various network source usage types

These values indicate how a UtilityNetworkSource is used in a utility network.

UtilityNetworkSourceUsageType can be one of:

ConstantValueDescription
UtilityNetworkSourceUsageType::Device0Network devices, such as transformers or valves.
UtilityNetworkSourceUsageType::Junction1Miscellaneous junctions not typically tracked as assets, such as taps.
UtilityNetworkSourceUsageType::Line2Lines such as conductors, pipes, or fiber strands.
UtilityNetworkSourceUsageType::Assembly3Assemblies such as switchgear.
UtilityNetworkSourceUsageType::SubnetLine4System-generated subnetwork lines.
UtilityNetworkSourceUsageType::StructureJunction5Point structures, such as poles.
UtilityNetworkSourceUsageType::StructureLine6Linear structures, such as ducts, conduits, or buffer tubes.
UtilityNetworkSourceUsageType::StructureBoundary7Polygonal structures, such as substations or town border stations.
UtilityNetworkSourceUsageType::JunctionObject8Non-spatial junctions, such as a transceiver in a fiber network.
UtilityNetworkSourceUsageType::EdgeObject9Non-spatial edge, such as a fiber strand in a fiber cable.
UtilityNetworkSourceUsageType::StructureJunctionObject10Non-spatial structure junction, such as a duct port in a manhole.
UtilityNetworkSourceUsageType::StructureEdgeObject11Non-spatial structure edge, such as a duct in a duct bank.

This enum was introduced or modified in Esri::ArcGISRuntime 100.6.

enum class UtilityPropagatorFunctionType

Enumerates the utility propagator function types.

UtilityPropagatorFunctionType can be one of:

ConstantValueDescription
UtilityPropagatorFunctionType::BitwiseAnd1The network attribute value of the current element is bitwise-anded with the network attribute value propagated from the source.
UtilityPropagatorFunctionType::Max2The network attribute value of the current element is compared against the network attribute value propagated from the source - the maximum of these values is propagated further.
UtilityPropagatorFunctionType::Min3The network attribute value of the current element is compared against the network attribute value propagated from the source - the minimum of these values is propagated further.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilitySubnetworkControllerType

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

UtilitySubnetworkControllerType can be one of:

ConstantValueDescription
UtilitySubnetworkControllerType::None0This domain network doesn't support subnetworks.
UtilitySubnetworkControllerType::Source1Subnetwork controllers within this domain network serve as sources.
UtilitySubnetworkControllerType::Sink2Subnetwork controllers within this domain network serve as sinks.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityTerminalDirectionality

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

UtilityTerminalDirectionality can be one of:

ConstantValueDescription
UtilityTerminalDirectionality::Unidirectional1Only one flow direction is permissible.
UtilityTerminalDirectionality::Bidirectional2Both flow directions are permissible.

This enum was introduced or modified in Esri::ArcGISRuntime 100.8.

enum class UtilityTierTopologyType

Enumerates the type of topology that makes up a UtilityTier definition.

UtilityTierTopologyType can be one of:

ConstantValueDescription
UtilityTierTopologyType::Radial1A radial network. Edges and junctions spread out radially from a single source.
UtilityTierTopologyType::Mesh2A mesh network. Edges and junctions are connected to multiple sources in an interconnected lattice.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityTierType

Enumerates the type of topology that makes up a UtilityTier definition.

UtilityTierType can be one of:

ConstantValueDescription
UtilityTierType::Hierarchical1A radial network. Edges and junctions spread out radially from a single source.
UtilityTierType::Partitioned2A mesh network. Edges and junctions are connected to multiple sources in an interconnected lattice.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityTraceConditionType

Enumerates the concrete type of a Utility Network trace condition.

UtilityTraceConditionType can be one of:

ConstantValueDescription
UtilityTraceConditionType::UtilityNetworkAttributeComparison0A condition comparing one network attribute directly to another.
UtilityTraceConditionType::UtilityCategoryComparison1A condition evaluating whether a network category exists on a node.
UtilityTraceConditionType::UtilityTraceAndCondition2A logical "AND" join of two sub-conditions.
UtilityTraceConditionType::UtilityTraceOrCondition3A logical "OR" join of two sub-conditions.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityTraceFunctionType

Enumerates the type of function calculation to perform.

UtilityTraceFunctionType can be one of:

ConstantValueDescription
UtilityTraceFunctionType::Add1Computes the sum of the network attribute from each applicable element.
UtilityTraceFunctionType::Average2Computes the average value of the network attribute from each applicable element.
UtilityTraceFunctionType::Count3Counts the number of applicable elements.
UtilityTraceFunctionType::Max4Computes the maximum value of the network attribute from each applicable element.
UtilityTraceFunctionType::Min5Computes the minimum value of the network attribute from each applicable element.
UtilityTraceFunctionType::Subtract6Takes the network attribute value from the starting point as the base number, and then subtracts the value of the network attribute from each applicable element.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.

enum class UtilityTraceResultObjectType

Enumerates the subclasses of UtilityTraceResult.

An enumeration of the result types returned by a trace operation. UtilityTraceResultObjectType can be one of:

ConstantValueDescription
UtilityTraceResultObjectType::UtilityElementTraceResult0A UtilityElementTraceResult object.
UtilityTraceResultObjectType::UtilityFunctionTraceResult1A UtilityFunctionTraceResult object.
UtilityTraceResultObjectType::UtilityGeometryTraceResult2A UtilityGeometryTraceResult object.

This enum was introduced or modified in Esri::ArcGISRuntime 100.6.

enum class UtilityTraceResultType

An enumeration of the result types returned by a trace operation.

The default is UtilityTraceResultType::Elements.

The UtilityTraceResultType can be one of:

ConstantValueDescription
UtilityTraceResultType::Elements0An array of UtilityElement objects.
UtilityTraceResultType::FunctionOutputs1An array of UtilityTraceFunctionOutput objects.
UtilityTraceResultType::Geometry2A trace result consisting of three distinct Geometry types: a Polygon, a {Esri::ArcGISRuntime::Polyline} {Polyline}, and a Multipoint.

This enum was introduced or modified in Esri::ArcGISRuntime 100.6.

enum class UtilityTraceType

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

The UtilityTraceType can be one of:

ConstantValueDescription
UtilityTraceType::Connected0A connected trace. Finds all features connected to a given set of starting points, ignoring traversability.
UtilityTraceType::Subnetwork1A subnetwork trace. Finds all features within the current subnetwork. This value is new since Esri::ArcGISRuntime 100.7.
UtilityTraceType::Upstream2An upstream trace.

For subnetworks with sources, upstream is defined as paths that lead to a source. For subnetworks with sinks, upstream is defined as paths that do not lead to a sink. This value is new since Esri::ArcGISRuntime 100.7.

ConstantValueDescription
UtilityTraceType::Downstream3A downstream trace.

For subnetworks with sources, downstream is defined as paths that do not lead to a source. For subnetworks with sinks, downstream is defined as paths that lead to a sink. This value is new since Esri::ArcGISRuntime 100.7.

ConstantValueDescription
UtilityTraceType::Isolation4An isolation trace.

The isolation trace requires that at least one UtilityTraceFilter barrier is set in the UtilityTraceConfiguration. Typically this filter identifies those features that isolate the section of network (e.g., valves). This value is new since Esri::ArcGISRuntime 100.8.

ConstantValueDescription
UtilityTraceType::Loops5Detects loops in the network.

The loops trace finds areas of the network where flow direction is ambiguous where resource can flow in either direction. Loops are expected with mesh networks but usually indicate error conditions in radial networks. This value is new since Esri::ArcGISRuntime 100.9.

ConstantValueDescription
UtilityTraceType::ShortestPath6Discovers the shortest path.

This trace returns the shortest path based on cost or distance, which is calculated using a numeric network attribute such as shape length. This value is new since Esri::ArcGISRuntime 100.9.

This enum was introduced or modified in Esri::ArcGISRuntime 100.6.

enum class UtilityTraversabilityScope

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

UtilityTraversabilityScope can be one of:

ConstantValueDescription
UtilityTraversabilityScope::JunctionsAndEdges0The traversability criteria should be evaluated at both junctions and edges.
UtilityTraversabilityScope::Junctions1The traversability criteria should only be evaluated at junctions.
UtilityTraversabilityScope::Edges2The traversability criteria should only be evaluated at edges.

This enum was introduced or modified in Esri::ArcGISRuntime 100.7.


Feedback on this topic?