Package uk.ac.manchester.spinnaker.alloc.allocator

Interface SpallocAPI.BoardLocation

Enclosing interface:
SpallocAPI
public static interface SpallocAPI.BoardLocation
Describes the locations of boards in a machine. Note that instances of this class are expected to be fully instantiated; reading from them will not touch the database.
Author:
Donal Fellows

  • Method Summary

    Modifier and Type Method Description
    uk.ac.manchester.spinnaker.machine.ChipLocation getBoardChip()
    Get the location of the characteristic chip of a board.
    uk.ac.manchester.spinnaker.machine.ChipLocation getChip()
    Where is the chip of interest? Usually the root chip of the board.
    uk.ac.manchester.spinnaker.machine.ChipLocation getChipRelativeTo​(@NotNull uk.ac.manchester.spinnaker.machine.ChipLocation rootChip)
    Get the location of this board location relative to another global location (the global location of the root chip of an allocation).
    SpallocAPI.Job getJob()
    What job is the board allocated to? May be null for an unallocated board.
    BoardCoordinates getLogical()
    Where is the board logically within its machine?
    String getMachine()
    What machine is the board on?
    BoardPhysicalCoordinates getPhysical()
    Where is the board physically in its machine?

  • Method Details

    • getBoardChip

      uk.ac.manchester.spinnaker.machine.ChipLocation getBoardChip()
      Get the location of the characteristic chip of a board. This is usually the root chip of the board.
      Returns:
      chip location, in global (whole machine) coordinates

    • getChipRelativeTo

      uk.ac.manchester.spinnaker.machine.ChipLocation getChipRelativeTo​(@NotNull @NotNull uk.ac.manchester.spinnaker.machine.ChipLocation rootChip)
      Get the location of this board location relative to another global location (the global location of the root chip of an allocation).
      Parameters:
      rootChip - The global location of the root chip of an allocation that we are converting this board location to be relative to.
      Returns:
      chip location, in relative (single job) coordinates

    • getMachine

      String getMachine()
      What machine is the board on?
      Returns:
      name of machine

    • getLogical

      BoardCoordinates getLogical()
      Where is the board logically within its machine?
      Returns:
      a triad location descriptor

    • getPhysical

      BoardPhysicalCoordinates getPhysical()
      Where is the board physically in its machine?
      Returns:
      a cabinet/frame/board triple

    • getChip

      uk.ac.manchester.spinnaker.machine.ChipLocation getChip()
      Where is the chip of interest? Usually the root chip of the board.
      Returns:
      a chip location, in global (whole machine) coordinates

    • getJob

      SpallocAPI.Job getJob()
      What job is the board allocated to? May be null for an unallocated board.
      Returns:
      a limited version of a job.