An entity in a utility network that corresponds to a Feature. More...
| Header: | #include <UtilityElement.h> |
| Since: | Esri::ArcGISRuntime 100.6 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~UtilityElement() override |
| Esri::ArcGISRuntime::UtilityAssetGroup * | assetGroup() const |
| Esri::ArcGISRuntime::UtilityAssetType * | assetType() const |
| double | fractionAlongEdge() const |
| QUuid | globalId() const |
(since Esri::ArcGISRuntime 100.11) bool | isValid() const |
| Esri::ArcGISRuntime::UtilityNetworkSource * | networkSource() const |
| qint64 | objectId() const |
| void | setFractionAlongEdge(double fractionAlongEdge) |
(since Esri::ArcGISRuntime 100.7) 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.
Relevant samples:
- Configure subnetwork trace: Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
- Create load report: Create a simple electric distribution report that displays the count of customers and total load per phase by tracing downstream from a given point.
- Display content of utility network container: A utility network container allows a dense collection of features to be represented by a single feature, which can be used to reduce map clutter.
- Perform valve isolation trace: Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.
- Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.
- Validate utility network topology: Demonstrates the workflow of getting the network state and validating the topology of a utility network.
Member Function Documentation
[override virtual noexcept] UtilityElement::~UtilityElement ()
Destructor.
Esri::ArcGISRuntime::UtilityAssetGroup *UtilityElement::assetGroup () const
Returns the asset group the element belongs to.
Esri::ArcGISRuntime::UtilityAssetType *UtilityElement::assetType () const
Returns the asset type the element belongs to.
double UtilityElement::fractionAlongEdge () const
Returns how far the starting point or barrier is located along an edge in the utility network feature, from 0.0 (edge's start) to 1.0 (edge's end).
This property is only valid when the globalId property refers to an dge feature that is an input to a tracing operation.
See also setFractionAlongEdge().
QUuid UtilityElement::globalId () const
Returns the global ID of the element.
[since Esri::ArcGISRuntime 100.11] 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 UtilityNetworkSource the element 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 the fractionAlongEdge to fractionAlongEdge.
See also fractionAlongEdge.
[since Esri::ArcGISRuntime 100.7] 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 utility network feature.
Only valid when the globalId refers to a device feature.
See also setTerminal().