AllocatedMachine (SpiNNaker Java Host 7.3.1 API)

java.lang.Object

uk.ac.manchester.spinnaker.alloc.client.AllocatedMachine

public final class AllocatedMachine
extends Object

A description of what boards have been allocated to a job.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class AllocatedMachine.ConnectionInfo
Information about a connection to a board.

Method Summary

Modifier and Type	Method	Description
`List<BoardCoordinates>`	`getBoards()`
`List<AllocatedMachine.ConnectionInfo>`	`getConnections()`
`int`	`getDepth()`
`int`	`getHeight()`
`SpallocClient.Machine`	`getMachine()`
`String`	`getMachineName()`
`int`	`getWidth()`

Methods inherited from class java.lang.Object

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

Method Details
- getWidth
  
  public int getWidth()
  
  Returns:
  
  Rectangle width, in triads.
- getHeight
  
  public int getHeight()
  
  Returns:
  
  Rectangle height, in triads.
- getDepth
  
  public int getDepth()
  
  Returns:
  
  Depth of rectangle. 1 or 3. Only the single-board case uses a depth of 1.
- getMachineName
  
  public String getMachineName()
  
  Returns:
  
  On what machine.
- getMachine
  
  public SpallocClient.Machine getMachine()
  
  Returns:
  
  The hosting SpiNNaker machine.
- getConnections
  
  public List<AllocatedMachine.ConnectionInfo> getConnections()
  
  Returns:
  
  How to talk to boards.
- getBoards
  
  public List<BoardCoordinates> getBoards()
  
  Returns:
  
  Where the boards are.