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

Class SpallocAPI.CreateNumBoards

java.lang.Object

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

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

Enclosing interface:

SpallocAPI

public static final class SpallocAPI.CreateNumBoards
extends SpallocAPI.CreateDescriptor

A request for a number of boards.

Field Summary

Fields

Modifier and Type	Field	Description
final @jakarta.validation.constraints.Positive(message="number of boards to request must be positive") int	numBoards	The number of boards requested.

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

maxDead

Constructor Summary

Constructors

Constructor	Description
CreateNumBoards(int numBoards, Integer maxDeadBoards)	Request a count of boards.

Method Summary

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

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

numBoards

@Positive(message="number of boards to request must be positive")
public final @jakarta.validation.constraints.Positive(message="number of boards to request must be positive") int numBoards

The number of boards requested.

Constructor Details

CreateNumBoards

public CreateNumBoards(int numBoards,
 Integer maxDeadBoards)

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

Parameters:

numBoards - The number of boards desired.

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

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.