Class UtilityTier


  • public final class UtilityTier
    extends Object
    Defines a utility network tier.

    Tiers demarcate a logical level within a network. For example, in an electric distribution network, there may be Subtransmission, Medium Voltage and Low Voltage tiers.

    Since:
    100.7.0
    • Method Detail

      • getName

        public String getName()
        Gets the tier's name.
        Returns:
        the name
        Since:
        100.7.0
      • getRank

        public int getRank()
        Gets the tier's numeric rank.

        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.

        Returns:
        the numeric rank
        Since:
        100.7.0
      • getTopologyType

        public UtilityTierTopologyType getTopologyType()
        Gets the tier's topology type.
        Returns:
        the topology type
        Since:
        100.7.0
      • getTraceConfiguration

        public UtilityTraceConfiguration getTraceConfiguration()
        Gets the tier's trace configuration.
        Returns:
        the trace configuration
        Since:
        100.7.0