UtilityTier Class

  • UtilityTier
  • class Esri::ArcGISRuntime::UtilityTier

    A logical level within a network. More...

    Header: #include <UtilityTier.h>
    Since: Esri::ArcGISRuntime 100.7
    Inherits: Esri::ArcGISRuntime::Object

    This class was introduced in Esri::ArcGISRuntime 100.7.

    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.

    Member Function Documentation

    [override virtual] UtilityTier::~UtilityTier()

    Destructor.

    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 a 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.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.