WhereIs (SpiNNaker Java Host 7.3.1 API)

java.lang.Object

uk.ac.manchester.spinnaker.alloc.client.WhereIs

public final class WhereIs
extends Object

A description of where a board is and what it is doing.

Method Summary

Modifier and Type	Method	Description
`ChipLocation`	`getBoardChip()`
`ChipLocation`	`getChip()`
`ChipLocation`	`getJobChip()`
`Integer`	`getJobId()`
`URI`	`getJobRef()`
`TriadCoords`	`getLogicalCoords()`
`SpallocClient.Machine`	`getMachineHandle()`
`String`	`getMachineName()`
`PhysicalCoords`	`getPhysicalCoords()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- getJobId
  
  public Integer getJobId()
  
  Returns:
  
  The ID of the job allocated to the board with the chip. null if none.
- getJobRef
  
  public URI getJobRef()
  
  Returns:
  
  The location of more information about the job allocated to the board with the chip. null if none.
- getJobChip
  
  public ChipLocation getJobChip()
  
  Returns:
  
  The global location of the chip at the root of the job allocation, if one exists.
- getChip
  
  public ChipLocation getChip()
  
  Returns:
  
  The global location of the chip.
- getMachineHandle
  
  public SpallocClient.Machine getMachineHandle()
  
  Returns:
  
  Information about the machine containing the chip.
- getMachineName
  
  public String getMachineName()
  
  Returns:
  
  The name of the machine containing the chip.
- getBoardChip
  
  public ChipLocation getBoardChip()
  
  Returns:
  
  The global location of the chip at the root of the board containing the chip being described.
- getLogicalCoords
  
  public TriadCoords getLogicalCoords()
  
  Returns:
  
  The logical coordinates for the board containing the chip.
- getPhysicalCoords
  
  public PhysicalCoords getPhysicalCoords()
  
  Returns:
  
  The physical coordinates for the board containing the chip.