Tiers demarcate a logical level within a network. More...
| Header: | #include <UtilityTier.h> |
| Since: | Esri::ArcGISRuntime 100.7 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| virtual | ~UtilityTier() override |
| Esri::ArcGISRuntime::UtilityTraceConfiguration * | defaultTraceConfiguration() const |
| QString | name() const |
| int | rank() const |
| Esri::ArcGISRuntime::UtilityTierTopologyType | topologyType() const |
Detailed Description
For example, in an electric distribution network, there may be Subtransmission, Medium Voltage and Low Voltage tiers.
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.
- 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.
Member Function Documentation
[override virtual] UtilityTier::~UtilityTier ()
Destructor.
[since Esri::ArcGISRuntime 100.12] Esri::ArcGISRuntime::UtilityTraceConfiguration *UtilityTier::defaultTraceConfiguration () const
Returns a copy of the UtilityTraceConfiguration for this UtilityTier, if one is defined.
This function was introduced in Esri::ArcGISRuntime 100.12.
QString UtilityTier::name() const
Returns the name of the UtilityTier.
int UtilityTier::rank() const
Returns the numeric rank of the tier.
It is possible for several tiers to have the same numeric rank. For example, in an electric distribution network, Radial Medium Voltage and Radial Multifeed Medium Voltage tiers would have the same rank. When doing a trace between a source tier and a target tier, the source and target tiers define an upper and lower tier value range for a trace. The trace will stop if it encounters a tier whose rank is outside the range specified by the source and target tiers.
Esri::ArcGISRuntime::UtilityTierTopologyType UtilityTier::topologyType () const
Returns the UtilityTierTopologyType of the tier.