Package com.esri.arcgisruntime.utilitynetworks

Class UtilityTerminalConfiguration

  • public final class UtilityTerminalConfiguration
extends Object
    Defines a utility network terminal configuration.
    Since:
    100.6.0

    • Method Detail

      • getTerminalConfigurationId

        public int getTerminalConfigurationId()
        Gets the terminal configuration ID.
        Returns:
        the terminal configuration ID
        Since:
        100.6.0

      • getName

        public String getName()
        Gets the name.
        Returns:
        the name
        Since:
        100.6.0

      • getTerminals

        public List<UtilityTerminal> getTerminals()
        Gets an unmodifiable list of the terminals.
        Returns:
        an unmodifiable list of the terminals
        Since:
        100.6.0

      • getConfigurationPaths

        public List<UtilityTerminalConfigurationPath> getConfigurationPaths()
        Get the configuration paths that constrain the flow paths between pairs of terminals.

        Of the set of possible paths that can be drawn between a set of terminals, these paths are the valid ones. If this UtilityTerminalConfiguration instance does not have configuration paths defined, an empty array is returned.

        Returns:
        an unmodifiable list of the configuration paths
        Since:
        100.8.0

      • getDefaultConfigurationPath

        public UtilityTerminalConfigurationPath getDefaultConfigurationPath()
        The default UtilityTerminalConfigurationPath defined for this terminal configuration.

        If this property returns null, configuration paths do not apply to this terminal configuration.

        Returns:
        the default utility terminal configuration path, or null if not set
        Since:
        100.8.0

      • getDirectionality

        public UtilityTerminalDirectionality getDirectionality()
        Gets the directionality setting of terminals on a device.

        Directionality specifies whether flow through a device is one-way or bidirectional.

        Returns:
        the directionality setting of terminals on a device
        Since:
        100.8.0