Class SpallocAPI.CreateDimensions

java.lang.Object

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

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

Enclosing interface:

SpallocAPI

public static final class SpallocAPI.CreateDimensions
extends SpallocAPI.CreateDescriptor

A request for a rectangle of boards. This is expressed in boards for reasons relating to the legacy API.

Author:

Donal Fellows

See Also:

• V1CompatService

Field Summary

Fields

Modifier and Type	Field	Description
final @ValidTriadHeight int	height	Height requested, in triads.
final @ValidTriadWidth int	width	Width requested, in triads.

Fields inherited from class SpallocAPI.CreateDescriptor

maxDead

Constructor Summary

Constructors

Constructor	Description
CreateDimensions(int width, int height, Integer maxDeadBoards)	Request a rectangle of boards.

Method Summary

Modifier and Type	Method	Description
int	getArea()	Get the area.

Methods inherited from class SpallocAPI.CreateDescriptor

visit

Methods inherited from class Object

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

Field Details

width

@ValidTriadWidth
public final @ValidTriadWidth int width

Width requested, in triads.

height

@ValidTriadHeight
public final @ValidTriadHeight int height

Height requested, in triads.

Constructor Details

CreateDimensions

public CreateDimensions(int width,
 int height,
 Integer maxDeadBoards)

Request a rectangle of boards. The service may over-allocate.

Parameters:

width - The width of rectangle to request, in triads.

height - The height of rectangle to request, in triads.

maxDeadBoards - The number of dead boards that can be tolerated in that rectangle.

Method Details

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.