Interface SpallocServiceAPI.MachineAPI
- Enclosing interface:
- SpallocServiceAPI
public static interface SpallocServiceAPI.MachineAPI
Interface to a particular machine.
- Author:
- Donal Fellows
-
Method Summary
Modifier and TypeMethodDescriptionvoid
describeMachine
(boolean wait, jakarta.ws.rs.container.AsyncResponse response) Describe the basic info about a machine.whereIsIPAddress
(@IPAddress String address) Get the location description of a board given its ethernet chip's IP address.whereIsLogicalPosition
(@uk.ac.manchester.spinnaker.machine.board.ValidTriadX int x, @uk.ac.manchester.spinnaker.machine.board.ValidTriadY int y, @uk.ac.manchester.spinnaker.machine.board.ValidTriadZ int z) Get the location description of a board given its logical coords.whereIsMachineChipLocation
(@uk.ac.manchester.spinnaker.machine.ValidX int x, @uk.ac.manchester.spinnaker.machine.ValidY int y) Get the location description of a board given the global coordinates of a chip on the board.whereIsPhysicalPosition
(@uk.ac.manchester.spinnaker.machine.board.ValidCabinetNumber int cabinet, @uk.ac.manchester.spinnaker.machine.board.ValidFrameNumber int frame, @uk.ac.manchester.spinnaker.machine.board.ValidBoardNumber int board) Get the location description of a board given its physical coords.
-
Method Details
-
describeMachine
@GET @Path("/") @Produces("application/json") void describeMachine(@QueryParam("wait") @DefaultValue("false") boolean wait, @Suspended jakarta.ws.rs.container.AsyncResponse response) Describe the basic info about a machine.- Parameters:
wait
- Whether to wait for a change.response
- Filled out with aMachineResponse
-
whereIsLogicalPosition
@GET @Path("logical-board") @Produces("application/json") WhereIsResponse whereIsLogicalPosition(@QueryParam("x") @ValidTriadX @uk.ac.manchester.spinnaker.machine.board.ValidTriadX int x, @QueryParam("y") @ValidTriadY @uk.ac.manchester.spinnaker.machine.board.ValidTriadY int y, @QueryParam("z") @DefaultValue("0") @ValidTriadZ @uk.ac.manchester.spinnaker.machine.board.ValidTriadZ int z) Get the location description of a board given its logical coords.- Parameters:
x
- Logical X coordinatey
- Logical Y coordinatez
- Logical Z coordinate (deprecated).- Returns:
- A board location description
-
whereIsPhysicalPosition
@GET @Path("physical-board") @Produces("application/json") WhereIsResponse whereIsPhysicalPosition(@QueryParam("cabinet") @DefaultValue("0") @ValidCabinetNumber @uk.ac.manchester.spinnaker.machine.board.ValidCabinetNumber int cabinet, @QueryParam("frame") @DefaultValue("0") @ValidFrameNumber @uk.ac.manchester.spinnaker.machine.board.ValidFrameNumber int frame, @QueryParam("board") @ValidBoardNumber @uk.ac.manchester.spinnaker.machine.board.ValidBoardNumber int board) Get the location description of a board given its physical coords.- Parameters:
cabinet
- Cabinet numberframe
- Frame numberboard
- Board number- Returns:
- A board location description
-
whereIsMachineChipLocation
@GET @Path("chip") @Produces("application/json") WhereIsResponse whereIsMachineChipLocation(@QueryParam("x") @ValidX @uk.ac.manchester.spinnaker.machine.ValidX int x, @QueryParam("y") @ValidY @uk.ac.manchester.spinnaker.machine.ValidY int y) Get the location description of a board given the global coordinates of a chip on the board.- Parameters:
x
- Global chip X coordinatey
- Global chip Y coordinate- Returns:
- A board location description
-
whereIsIPAddress
@GET @Path("board-ip") @Produces("application/json") WhereIsResponse whereIsIPAddress(@QueryParam("address") @IPAddress @IPAddress String address) Get the location description of a board given its ethernet chip's IP address.- Parameters:
address
- IP address- Returns:
- A board location description
-