Interface IPathingService

All Superinterfaces:
IGridService

public interface IPathingService extends IGridService
Provides services related to channel-allocation and a grid's controller.

Pathing / Path-finding refers to finding a path from a node to the grid's controller for the purposes of allocating channels.

  • Method Details

    • isNetworkBooting

      boolean isNetworkBooting()
      When the structure of a grid is changed in any way, the grid will reboot. While it is booting, the path from every grid node to the controller, and the number of channels will be re-calculated.

      The start and end of the boot process is signaled by the GridBootingStatusChange event.

      Returns:
      true if the network is in its booting stage
    • getControllerState

      ControllerState getControllerState()
      Returns:
      the controller state of the network, useful if you want to require a controller for a feature.
    • repath

      void repath()
      trigger a network reset, booting, path-finding and all.
    • getChannelMode

      ChannelMode getChannelMode()
      Returns:
      The current mode used for channel calculations.
    • getUsedChannels

      int getUsedChannels()
      Returns:
      The total number of channels currently used by this network.