UtilityElement Class
An entity in a utility network that corresponds to a Feature. More...
| Header: | #include <UtilityElement> |
| Since: | Esri::ArcGISRuntime 100.6 |
| Inherits: | Esri::ArcGISRuntime::Object |
This class was introduced in Esri::ArcGISRuntime 100.6.
Public Functions
| virtual | ~UtilityElement() override |
| Esri::ArcGISRuntime::UtilityAssetGroup * | assetGroup() const |
| Esri::ArcGISRuntime::UtilityAssetType * | assetType() const |
| double | fractionAlongEdge() const |
| QUuid | globalId() const |
| bool | isValid() const |
| Esri::ArcGISRuntime::UtilityNetworkSource * | networkSource() const |
| qint64 | objectId() const |
| void | setFractionAlongEdge(double fractionAlongEdge) |
| void | setTerminal(Esri::ArcGISRuntime::UtilityTerminal *terminal) |
| Esri::ArcGISRuntime::UtilityTerminal * | terminal() const |
Detailed Description
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
[override virtual] UtilityElement::~UtilityElement()
Destructor.
Esri::ArcGISRuntime::UtilityAssetGroup *UtilityElement::assetGroup() const
Returns the asset group that the UtilityElement belongs to.
Esri::ArcGISRuntime::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.
bool UtilityElement::isValid() const
Returns whether or not the UtilityElement has complete data available
When taking a UtilityNetwork offline, some of the data can be filtered out to limit the size of the data. This may leave some elements in an incomplete state. For example, one element of an association may be included in the offline dataset while the other element may not.
When an element is incomplete, the following properties should not be used:
When valid is false, the UtilityAssetType is assumed to have a UtilityAssociationDeletionSemantics of UtilityAssociationDeletionSemantics::Restricted.
This function was introduced in Esri::ArcGISRuntime 100.11.
Esri::ArcGISRuntime::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().
void UtilityElement::setTerminal(Esri::ArcGISRuntime::UtilityTerminal *terminal)
Sets the terminal to terminal.
This function was introduced in Esri::ArcGISRuntime 100.7.
See also terminal.
Esri::ArcGISRuntime::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.
See also setTerminal().