Class UtilityTerminal


  • public final class UtilityTerminal
    extends java.lang.Object
    Defines a utility network terminal.
    Since:
    100.6.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Gets the terminal's name.
      int getTerminalId()
      Gets the terminal ID.
      boolean isUpstreamTerminal()
      Indicates whether this terminal is on the upstream side of the device.
      • Methods inherited from class java.lang.Object

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

      • getTerminalId

        public int getTerminalId()
        Gets the terminal ID.
        Returns:
        the terminal ID
        Since:
        100.6.0
      • getName

        public java.lang.String getName()
        Gets the terminal's name.
        Returns:
        the name
        Since:
        100.6.0
      • isUpstreamTerminal

        public boolean isUpstreamTerminal()
        Indicates whether this terminal is on the upstream side of the device.

        In source-based networks, upstream is towards the subnetwork controller. In sink-based networks, upstream is away from the subnetwork controller.

        Returns:
        true if this terminal is on the upstream side of the device, false otherwise
        Since:
        100.8.0