Package com.esri.arcgisruntime.utilitynetworks

Class UtilityDomainNetwork

  • public final class UtilityDomainNetwork
extends Object
    Defines the domain network of a Utility Network.

    Domain networks organize features in a utility network based on what utility service they provide, such as natural gas, water, electricity, or structural elements such as poles or conduits. Each utility network will have a single structure network and one or more domain networks for the actual utility services they provide.

    Since:
    100.7.0

    • Method Detail

      • getAlias

        public String getAlias()
        Gets the display (non-normalized) name of the utility domain network.
        Returns:
        the alias of the utility domain network
        Since:
        100.7.0

      • getDomainNetworkId

        public int getDomainNetworkId()
        Gets the ID of the utility domain network.
        Returns:
        the utility domain network ID
        Since:
        100.7.0

      • isStructureNetwork

        public boolean isStructureNetwork()
        Returns true if the utility domain network is the structure network.
        Returns:
        true if the utility domain network is the structure network, false otherwise
        Since:
        100.7.0

      • getName

        public String getName()
        Gets the normalized name of the utility domain network.
        Returns:
        the normalized name
        Since:
        100.7.0

      • getNetworkSources

        public List<UtilityNetworkSource> getNetworkSources()
        Gets an unmodifiable list of utility network source objects in the utility domain network.
        Returns:
        an unmodifiable list of utility network source objects
        Since:
        100.7.0

      • getSubnetworkControllerType

        public UtilitySubnetworkControllerType getSubnetworkControllerType()
        Gets the type of subnetwork controller supported in this utility domain network.
        Returns:
        the subnetwork controller type
        Since:
        100.7.0

      • getTierGroups

        public List<UtilityTierGroup> getTierGroups()
        Gets an unmodifiable list of all utility tier group objects for this domain network.
        Returns:
        an unmodifiable list of utility tier group objects
        Since:
        100.7.0

      • getTiers

        public List<UtilityTier> getTiers()
        Gets an unmodifiable list of all utility tier objects for this domain network.
        Returns:
        an unmodifiable list of utility tier objects
        Since:
        100.7.0

      • getTierType

        public UtilityTierType getTierType()
        Gets the tier type of this domain network.
        Returns:
        the tier type
        Since:
        100.7.0

      • getTier

        public UtilityTier getTier​(String tierName)
        Gets the utility tier with the specified name.
        Parameters:
        tierName - the name of the desired utility tier to return
        Returns:
        a utility tier with the specified name or null if tierName not found
        Throws:
        IllegalArgumentException - if tierName is null or empty
        Since:
        100.7.0

      • getTierGroup

        public UtilityTierGroup getTierGroup​(String tierGroupName)
        Gets the utility tier group with the specified name.
        Parameters:
        tierGroupName - the name of the desired utility tier group object to return
        Returns:
        a utility tier group with the specified name or null if tierGroupname not found
        Throws:
        IllegalArgumentException - if tierGroupName is null or empty
        Since:
        100.7.0