Class UtilityTierGroup


  • public final class UtilityTierGroup
    extends java.lang.Object
    Defines a utility tier group.

    Tier groups provide an extra level of organization for tiers. For example, a gas network may be divided into two tier groups - Transmission and Distribution. Each of these tier groups would contain a set of tiers specific to that group. For example, Distribution Pressure and Distribution Isolation might be tiers within the Distribution tier group.

    Since:
    100.7.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Gets the tier group's name.
      UtilityTier getTier​(java.lang.String tierName)
      Gets the utility tier specified by the name argument.
      java.util.List<UtilityTier> getTiers()
      Gets an unmodifiable list of utility tier objects within this tier group.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getName

        public java.lang.String getName()
        Gets the tier group's name.
        Returns:
        the name
        Since:
        100.7.0
      • getTiers

        public java.util.List<UtilityTier> getTiers()
        Gets an unmodifiable list of utility tier objects within this tier group.
        Returns:
        an unmodifiable list of utility tier objects
        Since:
        100.7.0
      • getTier

        public UtilityTier getTier​(java.lang.String tierName)
        Gets the utility tier specified by the name argument.
        Parameters:
        tierName - the name of the utility tier to retrieve
        Returns:
        the utility tier or null if tierName not found
        Throws:
        java.lang.IllegalArgumentException - if tierName is null or empty
        Since:
        100.7.0