Interface SpallocServiceAPI.MachineAPI

Enclosing interface:

SpallocServiceAPI

public static interface SpallocServiceAPI.MachineAPI

Interface to a particular machine.

Author:

Donal Fellows

Method Summary

Modifier and Type	Method	Description
void	describeMachine(boolean wait, AsyncResponse response)	Describe the basic info about a machine.
WhereIsResponse	whereIsIPAddress(@IPAddress String address)	Get the location description of a board given its ethernet chip's IP address.
WhereIsResponse	whereIsLogicalPosition(@ValidTriadX int x, @ValidTriadY int y, @ValidTriadZ int z)	Get the location description of a board given its logical coords.
WhereIsResponse	whereIsMachineChipLocation(@ValidX int x, @ValidY int y)	Get the location description of a board given the global coordinates of a chip on the board.
WhereIsResponse	whereIsPhysicalPosition(@ValidCabinetNumber int cabinet, @ValidFrameNumber int frame, @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
 AsyncResponse response)

Describe the basic info about a machine.

Parameters:

wait - Whether to wait for a change.

response - Filled out with a MachineResponse

whereIsLogicalPosition

@GET
@Path("logical-board")
@Produces("application/json")
WhereIsResponse whereIsLogicalPosition(@QueryParam("x") @ValidTriadX
 @ValidTriadX int x,
 @QueryParam("y") @ValidTriadY
 @ValidTriadY int y,
 @QueryParam("z") @DefaultValue("0") @ValidTriadZ
 @ValidTriadZ int z)

Get the location description of a board given its logical coords.

Parameters:

x - Logical X coordinate

y - Logical Y coordinate

z - Logical Z coordinate (deprecated).

Returns:

A board location description

whereIsPhysicalPosition

@GET
@Path("physical-board")
@Produces("application/json")
WhereIsResponse whereIsPhysicalPosition(@QueryParam("cabinet") @DefaultValue("0") @ValidCabinetNumber
 @ValidCabinetNumber int cabinet,
 @QueryParam("frame") @DefaultValue("0") @ValidFrameNumber
 @ValidFrameNumber int frame,
 @QueryParam("board") @ValidBoardNumber
 @ValidBoardNumber int board)

Get the location description of a board given its physical coords.

Parameters:

cabinet - Cabinet number

frame - Frame number

board - Board number

Returns:

A board location description

whereIsMachineChipLocation

@GET
@Path("chip")
@Produces("application/json")
WhereIsResponse whereIsMachineChipLocation(@QueryParam("x") @ValidX
 @ValidX int x,
 @QueryParam("y") @ValidY
 @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 coordinate

y - 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