Package uk.ac.manchester.spinnaker.alloc.allocator

Class SpallocAPI.CreateDimensionsAt

java.lang.Object

uk.ac.manchester.spinnaker.alloc.allocator.SpallocAPI.CreateDescriptor

uk.ac.manchester.spinnaker.alloc.allocator.SpallocAPI.HasBoardCoords

uk.ac.manchester.spinnaker.alloc.allocator.SpallocAPI.CreateDimensionsAt

Enclosing interface:

SpallocAPI

public static final class SpallocAPI.CreateDimensionsAt
extends SpallocAPI.HasBoardCoords

A request for a rectangle of triads rooted at a particular triad. No option for using physical coordinates is supported with this method.

Field Summary

Fields

Modifier and Type	Field	Description
final @uk.ac.manchester.spinnaker.machine.board.ValidTriadHeight int	height	Height requested, in triads.
final @uk.ac.manchester.spinnaker.machine.board.ValidTriadWidth int	width	Width requested, in triads.

Fields inherited from class uk.ac.manchester.spinnaker.alloc.allocator.SpallocAPI.HasBoardCoords

ip, physical, triad

Fields inherited from class uk.ac.manchester.spinnaker.alloc.allocator.SpallocAPI.CreateDescriptor

maxDead

Constructor Summary

Constructors

Constructor	Description
CreateDimensionsAt(int width, int height, int x, int y, int z, Integer maxDeadBoards)	Create a request for a rectangle at a specific board.
CreateDimensionsAt(int width, int height, int x, int y, Integer maxDeadBoards)	Create a request for a rectangle at a specific board.
CreateDimensionsAt(int width, int height, Integer x, Integer y, Integer maxDeadBoards)	Create a request for a rectangle at a specific board.
CreateDimensionsAt(int width, int height, Integer x, Integer y, Integer z, Integer maxDeadBoards)	Create a request for a rectangle at a specific board.
CreateDimensionsAt(int width, int height, String ip, Integer maxDeadBoards)	Create a request for a rectangle at a specific board.

Method Summary

Modifier and Type	Method	Description
int	getArea()	Get the area.
static SpallocAPI.CreateDimensionsAt	physical(int width, int height, int cabinet, int frame, int board, Integer maxDeadBoards)	Create a request for a rectangle at a specific board.
static SpallocAPI.CreateDimensionsAt	physical(int width, int height, Integer cabinet, Integer frame, Integer board, Integer maxDeadBoards)	Create a request for a rectangle at a specific board.

Methods inherited from class uk.ac.manchester.spinnaker.alloc.allocator.SpallocAPI.CreateDescriptor

visit

Methods inherited from class java.lang.Object

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

Field Details

width

@ValidTriadWidth
public final @uk.ac.manchester.spinnaker.machine.board.ValidTriadWidth int width

Width requested, in triads.

height

@ValidTriadHeight
public final @uk.ac.manchester.spinnaker.machine.board.ValidTriadHeight int height

Height requested, in triads.

Constructor Details

CreateDimensionsAt

public CreateDimensionsAt(int width,
 int height,
 int x,
 int y,
 Integer maxDeadBoards)

Create a request for a rectangle at a specific board. The board will have a Z coordinate of 0.

Parameters:

width - Width requested, in triads.

height - Height requested, in triads.

x - The X coordinate of the root board of the request.

y - The Y coordinate of the root board of the request.

maxDeadBoards - The maximum number of dead boards tolerated in the allocation. Ignored when asking for a single board.

CreateDimensionsAt

public CreateDimensionsAt(int width,
 int height,
 Integer x,
 Integer y,
 Integer maxDeadBoards)

Create a request for a rectangle at a specific board. The board will have a Z coordinate of 0.

Parameters:

width - Width requested, in triads.

height - Height requested, in triads.

x - The X coordinate of the root board of the request.

y - The Y coordinate of the root board of the request.

maxDeadBoards - The maximum number of dead boards tolerated in the allocation. Ignored when asking for a single board.

CreateDimensionsAt

public CreateDimensionsAt(int width,
 int height,
 int x,
 int y,
 int z,
 Integer maxDeadBoards)

Create a request for a rectangle at a specific board. The board must have a Z coordinate of 0.

Parameters:

width - Width requested, in triads.

height - Height requested, in triads.

x - The X coordinate of the root board of the request.

y - The Y coordinate of the root board of the request.

z - The Z coordinate of the root board of the request.

maxDeadBoards - The maximum number of dead boards tolerated in the allocation. Ignored when asking for a single board.

CreateDimensionsAt

public CreateDimensionsAt(int width,
 int height,
 Integer x,
 Integer y,
 Integer z,
 Integer maxDeadBoards)

Create a request for a rectangle at a specific board. The board must have a Z coordinate of 0.

Parameters:

width - Width requested, in triads.

height - Height requested, in triads.

x - The X coordinate of the root board of the request.

y - The Y coordinate of the root board of the request.

z - The Z coordinate of the root board of the request.

maxDeadBoards - The maximum number of dead boards tolerated in the allocation. Ignored when asking for a single board.

CreateDimensionsAt

public CreateDimensionsAt(int width,
 int height,
 String ip,
 Integer maxDeadBoards)

Create a request for a rectangle at a specific board. The board must have a Z coordinate of 0.

Parameters:

width - Width requested, in triads.

height - Height requested, in triads.

ip - The network address of the root board of the request.

maxDeadBoards - The maximum number of dead boards tolerated in the allocation. Ignored when asking for a single board.

Method Details

physical

public static SpallocAPI.CreateDimensionsAt physical(int width,
 int height,
 int cabinet,
 int frame,
 int board,
 Integer maxDeadBoards)

Create a request for a rectangle at a specific board. The board must have a Z coordinate of 0.

Parameters:

width - Width requested, in triads.

height - Height requested, in triads.

cabinet - The cabinet number of the root board of the request.

frame - The frame number of the root board.

board - The board number of the root board.

maxDeadBoards - The maximum number of dead boards tolerated in the allocation. Ignored when asking for a single board.

Returns:

Descriptor

physical

public static SpallocAPI.CreateDimensionsAt physical(int width,
 int height,
 Integer cabinet,
 Integer frame,
 Integer board,
 Integer maxDeadBoards)

Create a request for a rectangle at a specific board. The board must have a Z coordinate of 0.

Parameters:

width - Width requested, in triads.

height - Height requested, in triads.

cabinet - The cabinet number of the root board of the request.

frame - The frame number of the root board.

board - The board number of the root board.

maxDeadBoards - The maximum number of dead boards tolerated in the allocation. Ignored when asking for a single board.

Returns:

Descriptor

getArea

public int getArea()

Description copied from class: SpallocAPI.CreateDescriptor

Get the area. The area is the number of boards required.

Specified by:

getArea in class SpallocAPI.CreateDescriptor

Returns:

The number of boards requested by the job.