Interface HasBMPLocation

All Known Implementing Classes:
BMPLocation, SDPLocation

public interface HasBMPLocation
The interface supported by any object that is associated with a board location.
  • Method Summary

    Modifier and Type Method Description
    default BMPLocation asBMPLocation()
    Converts (if required) this to a simple X, Y, P tuple.
    @uk.ac.manchester.spinnaker.machine.board.ValidBoardNumber int getBoard()  
    @uk.ac.manchester.spinnaker.machine.board.ValidCabinetNumber int getCabinet()  
    @uk.ac.manchester.spinnaker.machine.board.ValidFrameNumber int getFrame()  
  • Method Details

    • getCabinet

      @ValidCabinetNumber @uk.ac.manchester.spinnaker.machine.board.ValidCabinetNumber int getCabinet()
      Returns:
      The cabinet number of the board. Not actually a processor coordinate.
    • getFrame

      @ValidFrameNumber @uk.ac.manchester.spinnaker.machine.board.ValidFrameNumber int getFrame()
      Returns:
      The frame number of the board. Not actually a processor coordinate.
    • getBoard

      @ValidBoardNumber @uk.ac.manchester.spinnaker.machine.board.ValidBoardNumber int getBoard()
      Returns:
      The board number of the board. Not actually a processor ID.
    • asBMPLocation

      default BMPLocation asBMPLocation()
      Converts (if required) this to a simple X, Y, P tuple.
      Returns:
      A CoreLocation representation of the X, Y, P tuple