Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityElement Class

(Esri::ArcGISRuntime::UtilityElement)

An entity in a utility network that corresponds to a Feature. More...

Header: #include <UtilityElement>
Since: Esri::ArcGISRuntime 100.6
Inherits: Object

Public Functions

~UtilityElement()
UtilityAssetGroup *assetGroup() const
UtilityAssetType *assetType() const
double fractionAlongEdge() const
QUuid globalId() const
UtilityNetworkSource *networkSource() const
qint64 objectId() const
void setFractionAlongEdge(double fractionAlongEdge)
UtilityTerminal *terminal() const
  • 31 public functions inherited from QObject

Additional Inherited Members

Detailed Description

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 UtilityTerminal (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.

Member Function Documentation

UtilityElement::~UtilityElement()

Destructor.

UtilityAssetGroup *UtilityElement::assetGroup() const

Returns the asset group that the UtilityElement belongs to.

UtilityAssetType *UtilityElement::assetType() const

Returns the asset type of the UtilityElement.

double UtilityElement::fractionAlongEdge() const

Returns how far the starting point or barrier is located along an edge in the utility network feature.

Valid values are from 0.0 (edge's start) to 1.0 (edge's end).

This property is only valid when the UtilityElement::globalId property refers to an edge feature that is an input to a tracing operation.

See also setFractionAlongEdge.

QUuid UtilityElement::globalId() const

Returns the globalID of the UtilityElement.

UtilityNetworkSource *UtilityElement::networkSource() const

Returns the network source the UtilityElement is from.

qint64 UtilityElement::objectId() const

Returns the object ID of the corresponding feature in the UtilityElement::networkSource.

This is only valid on results from a tracing operation, or with elements that are created from an ArcGISFeature. Otherwise, a value of -1 is returned.

void UtilityElement::setFractionAlongEdge(double fractionAlongEdge)

Sets how far the starting point or barrier is located along an edge in the utility network feature to fractionAlongEdge.

Valid values are from 0.0 (edge's start) to 1.0 (edge's end).

This property is only valid when the UtilityElement::globalId property refers to an edge feature that is an input to a tracing operation.

See also fractionAlongEdge().

UtilityTerminal *UtilityElement::terminal() const

Returns the UtilityTerminal of the starting point or barrier utility network feature.

This is only valid when UtilityElement::globalId refers to a device junction feature that has terminals.


Feedback on this topic?