<UtilityNetworkTypes.h> - Utility Network Enums

Collection of Utility Network enumerations. More...

Header: #include <UtilityNetworkTypes.h>

Types

enum class	UtilityAssociationDeletionSemantics { None, Cascade, Restricted }
enum class	UtilityAssociationRole { None, Container, Structure }
enum class	UtilityAssociationType { Connectivity, Containment, Attachment, JunctionEdgeObjectConnectivityFromSide, JunctionEdgeObjectConnectivityMidspan, JunctionEdgeObjectConnectivityToSide }
enum class	UtilityAttributeComparisonOperator { Equal, NotEqual, GreaterThan, GreaterThanEqual, LessThan, …, DoesNotIncludeAny }
enum class	UtilityCategoryComparisonOperator { Exists, DoesNotExist }
enum class	UtilityMinimumStartingLocations { One, Many }
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 UtilityAssociationDeletionSemantics

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.

The UtilityAssociationDeletionSemantics can be one of:

Constant	Value	Description
`UtilityAssociationDeletionSemantics::None`	`0`	Any associated features will not be deleted, but the associations will no longer exist. Default for UtilityAssociationRole::Structure.
`UtilityAssociationDeletionSemantics::Cascade`	`1`	Any associations features will be deleted.
`UtilityAssociationDeletionSemantics::Restricted`	`2`	If the feature has any associations, deleting the feature will fail. Default for UtilityAssociationRole::Container.

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

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:

Constant	Value	Description
`UtilityAssociationRole::None`	`0`	These are features that are neither a container nor a structure but can connect to or be contained by other structures.
`UtilityAssociationRole::Container`	`1`	Features of this asset type can contain other features as contents.
`UtilityAssociationRole::Structure`	`2`	Features 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:

Constant	Value	Description
`UtilityAssociationType::Connectivity`	`1`	The association represents connectivity between two junctions.
`UtilityAssociationType::Containment`	`2`	The association represents containment of one Esri::ArcGISRuntime::UtilityElement within another.
`UtilityAssociationType::Attachment`	`3`	The association represents a structural attachment.
`UtilityAssociationType::JunctionEdgeObjectConnectivityFromSide`	`4`	The association represents a junction or non-spatial junction connected to the end point of a non-spatial edge.
`UtilityAssociationType::JunctionEdgeObjectConnectivityMidspan`	`5`	The association represents a junction or non-spatial junction connected along the midspan of a non-spatial edge.
`UtilityAssociationType::JunctionEdgeObjectConnectivityToSide`	`6`	The association represents a junction or non-spatial junction connected to the start point of a non-spatial edge.

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:

Constant	Value	Description
`UtilityAttributeComparisonOperator::Equal`	`0`	Tests whether an attribute is equal to another attribute or a specific value.
`UtilityAttributeComparisonOperator::NotEqual`	`1`	Tests whether an attribute is not equal to another attribute or a specific value.
`UtilityAttributeComparisonOperator::GreaterThan`	`2`	Tests whether an attribute is greater than another attribute or a specific value.
`UtilityAttributeComparisonOperator::GreaterThanEqual`	`3`	Tests whether an attribute is greater than or equal to another attribute or a specific value.
`UtilityAttributeComparisonOperator::LessThan`	`4`	Tests whether an attribute is less than another attribute or a specific value.
`UtilityAttributeComparisonOperator::LessThanEqual`	`5`	Tests whether an attribute is less than or equal to another attribute or a specific value.
`UtilityAttributeComparisonOperator::IncludesTheValues`	`6`	Tests whether an attribute includes all the values specified in another attribute or the particular values contained in the condition.
`UtilityAttributeComparisonOperator::DoesNotIncludeTheValues`	`7`	Tests whether an attribute does not include all of the values specified in another attribute or the particular values in the condition.
`UtilityAttributeComparisonOperator::IncludesAny`	`8`	Tests whether an attribute includes any of the values specified in another attribute or the particular values contained in the condition.
`UtilityAttributeComparisonOperator::DoesNotIncludeAny`	`9`	Tests 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:

Constant	Value	Description
`UtilityCategoryComparisonOperator::Exists`	`0`	Evaluate that the UtilityCategory exists on a network feature.
`UtilityCategoryComparisonOperator::DoesNotExist`	`1`	Evaluate that the UtilityCategory does not exist on a network feature.

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

enum class UtilityMinimumStartingLocations

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

The UtilityMinimumStartingLocations can be one of:

Constant	Value	Description
`UtilityMinimumStartingLocations::One`	`1`	At least one starting point is necessary for the particular trace parameters. Downstream traces require at least `1` starting point.
`UtilityMinimumStartingLocations::Many`	`2`	At least `2` starting points are necessary for the particular trace parameters. A shortestPath trace requires at least `2` starting points.

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

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:

Constant	Value	Description
`UtilityNetworkAttributeDataType::Integer`	`0`	A signed 64-bit integer value.
`UtilityNetworkAttributeDataType::Float`	`1`	A floating point value.
`UtilityNetworkAttributeDataType::Double`	`2`	A double precision floating point value.
`UtilityNetworkAttributeDataType::Boolean`	`3`	A Boolean m-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:

Constant	Value	Description
`UtilityNetworkSourceType::Junction`	`0`	The network source references junctions in a feature class or table.
`UtilityNetworkSourceType::Edge`	`1`	The 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:

Constant	Value	Description
`UtilityNetworkSourceUsageType::Device`	`0`	Network devices, such as transformers or valves.
`UtilityNetworkSourceUsageType::Junction`	`1`	Miscellaneous junctions not typically tracked as assets, such as taps.
`UtilityNetworkSourceUsageType::Line`	`2`	Lines such as conductors, pipes, or fiber strands.
`UtilityNetworkSourceUsageType::Assembly`	`3`	Assemblies such as switchgear.
`UtilityNetworkSourceUsageType::SubnetLine`	`4`	System-generated subnetwork lines.
`UtilityNetworkSourceUsageType::StructureJunction`	`5`	Point structures, such as poles.
`UtilityNetworkSourceUsageType::StructureLine`	`6`	Linear structures, such as ducts, conduits, or buffer tubes.
`UtilityNetworkSourceUsageType::StructureBoundary`	`7`	Polygonal structures, such as substations or town border stations.
`UtilityNetworkSourceUsageType::JunctionObject`	`8`	Non-spatial junctions, such as a transceiver in a fiber network.
`UtilityNetworkSourceUsageType::EdgeObject`	`9`	Non-spatial edge, such as a fiber strand in a fiber cable.
`UtilityNetworkSourceUsageType::StructureJunctionObject`	`10`	Non-spatial structure junction, such as a duct port in a manhole.
`UtilityNetworkSourceUsageType::StructureEdgeObject`	`11`	Non-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:

Constant	Value	Description
`UtilityPropagatorFunctionType::BitwiseAnd`	`1`	The network attribute value of the current element is bitwise-anded with the network attribute value propagated from the source.
`UtilityPropagatorFunctionType::Max`	`2`	The 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::Min`	`3`	The 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:

Constant	Value	Description
`UtilitySubnetworkControllerType::None`	`0`	This domain network does not support subnetworks.
`UtilitySubnetworkControllerType::Source`	`1`	Subnetwork controllers within this domain network serve as sources.
`UtilitySubnetworkControllerType::Sink`	`2`	Subnetwork 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:

Constant	Value	Description
`UtilityTerminalDirectionality::Unidirectional`	`1`	Only one flow direction is permissible.
`UtilityTerminalDirectionality::Bidirectional`	`2`	Both 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:

Constant	Value	Description
`UtilityTierTopologyType::Radial`	`1`	A radial network. Edges and junctions spread out radially from a single source.
`UtilityTierTopologyType::Mesh`	`2`	A 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:

Constant	Value	Description
`UtilityTierType::Hierarchical`	`1`	A radial network. Edges and junctions spread out radially from a single source.
`UtilityTierType::Partitioned`	`2`	A 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:

Constant	Value	Description
`UtilityTraceConditionType::UtilityNetworkAttributeComparison`	`0`	A condition comparing one network attribute directly to another.
`UtilityTraceConditionType::UtilityCategoryComparison`	`1`	A condition evaluating whether a network category exists on a node.
`UtilityTraceConditionType::UtilityTraceAndCondition`	`2`	A logical "AND" join of two sub-conditions.
`UtilityTraceConditionType::UtilityTraceOrCondition`	`3`	A 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:

Constant	Value	Description
`UtilityTraceFunctionType::Add`	`1`	Computes the sum of the network attribute from each applicable element.
`UtilityTraceFunctionType::Average`	`2`	Computes the average value of the network attribute from each applicable element.
`UtilityTraceFunctionType::Count`	`3`	Counts the number of applicable elements.
`UtilityTraceFunctionType::Max`	`4`	Computes the maximum value of the network attribute from each applicable element.
`UtilityTraceFunctionType::Min`	`5`	Computes the minimum value of the network attribute from each applicable element.
`UtilityTraceFunctionType::Subtract`	`6`	Takes 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:

Constant	Value	Description
`UtilityTraceResultObjectType::UtilityElementTraceResult`	`0`	A UtilityElementTraceResult object.
`UtilityTraceResultObjectType::UtilityFunctionTraceResult`	`1`	A UtilityFunctionTraceResult object.
`UtilityTraceResultObjectType::UtilityGeometryTraceResult`	`2`	A 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:

Constant	Value	Description
`UtilityTraceResultType::Elements`	`0`	An array of UtilityElement objects.
`UtilityTraceResultType::FunctionOutputs`	`1`	An array of UtilityTraceFunctionOutput objects.
`UtilityTraceResultType::Geometry`	`2`	A 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:

Constant	Value	Description
`UtilityTraceType::Connected`	`0`	A connected trace. Finds all features connected to a given set of starting points, ignoring traversability.
`UtilityTraceType::Subnetwork`	`1`	A subnetwork trace. Finds all features within the current subnetwork. This value is new since Esri::ArcGISRuntime 100.7.
`UtilityTraceType::Upstream`	`2`	An 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.

Constant	Value	Description
`UtilityTraceType::Downstream`	`3`	A 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.

Constant	Value	Description
`UtilityTraceType::Isolation`	`4`	An 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.

Constant	Value	Description
`UtilityTraceType::Loops`	`5`	Detects 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.

Constant	Value	Description
`UtilityTraceType::ShortestPath`	`6`	Discovers 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:

Constant	Value	Description
`UtilityTraversabilityScope::JunctionsAndEdges`	`0`	The traversability criteria should be evaluated at both junctions and edges.
`UtilityTraversabilityScope::Junctions`	`1`	The traversability criteria should only be evaluated at junctions.
`UtilityTraversabilityScope::Edges`	`2`	The traversability criteria should only be evaluated at edges.

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