Package uk.ac.manchester.spinnaker.spalloc.messages

Class WhereIs

java.lang.Object

uk.ac.manchester.spinnaker.spalloc.messages.WhereIs

@Immutable
public final class WhereIs
extends Object

The description of where some resource is on a SpiNNaker system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WhereIs.Builder	Builder for WhereIs.

Constructor Summary

Constructors

Constructor	Description
WhereIs(ChipLocation jobChip, Integer jobId, ChipLocation chip, BoardCoordinates logical, String machine, ChipLocation boardChip, BoardPhysicalCoordinates physical)	Create.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ChipLocation	getBoardChip()	Get the chip location relative to the board.
ChipLocation	getChip()	Get the chip.
ChipLocation	getJobChip()	Get the chip location relative to the job's allocation.
Integer	getJobId()	Get the job id.
BoardCoordinates	getLogical()	Get the logical board coordinates.
String	getMachine()	Get the machine.
BoardPhysicalCoordinates	getPhysical()	Get the physical board coordinates.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

WhereIs

public WhereIs(ChipLocation jobChip,
 Integer jobId,
 ChipLocation chip,
 BoardCoordinates logical,
 String machine,
 ChipLocation boardChip,
 BoardPhysicalCoordinates physical)

Create.

Parameters:

jobChip - the chip location relative to the job's allocation.

jobId - the job id.

chip - the absolute chip location.

logical - the logical coordinates of the board

machine - the name of the machine

boardChip - the chip location relative to its board

physical - the physical coordinates of the board

Method Details

getJobChip

public ChipLocation getJobChip()

Get the chip location relative to the job's allocation.

Returns:

the job-relative chip location

getJobId

public Integer getJobId()

Get the job id.

Returns:

the job id

getChip

public ChipLocation getChip()

Get the chip.

Returns:

the chip

getLogical

public BoardCoordinates getLogical()

Get the logical board coordinates.

Returns:

the logical board coordinates

getMachine

public String getMachine()

Get the machine.

Returns:

the machine

getBoardChip

public ChipLocation getBoardChip()

Get the chip location relative to the board.

Returns:

the board chip location

getPhysical

public BoardPhysicalCoordinates getPhysical()

Get the physical board coordinates.

Returns:

the physical board coordinates

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object