Package uk.ac.manchester.spinnaker.messages.model

Enum Class FPGA

java.lang.Object

java.lang.Enum<FPGA>

uk.ac.manchester.spinnaker.messages.model.FPGA

All Implemented Interfaces:

Serializable, Comparable<FPGA>, Constable

public enum FPGA
extends Enum<FPGA>

Identifiers for the FPGAs on a SpiNNaker board, as managed by BMP.

SpiNNaker FPGA identifiers, taken from the SpiNN-5 FPGA SATA Links datasheet.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FPGA_ALL	All three FPGAs.
FPGA_E_S	The first FPGA.
FPGA_N_NE	The third FPGA.
FPGA_SW_W	The second FPGA.

Field Summary

Fields

Modifier and Type	Field	Description
final int	bits	The bit encoding for read and write requests.
final String	name	The "name" of the FPGA.
final int	value	The FPGA identifier in protocol terms.

Method Summary

Modifier and Type	Method	Description
boolean	isSingleFPGA()
String	toString()
static FPGA	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FPGA[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FPGA_E_S

public static final FPGA FPGA_E_S

The first FPGA. Handles east and south.

FPGA_SW_W

public static final FPGA FPGA_SW_W

The second FPGA. Handles south-west and west.

FPGA_N_NE

public static final FPGA FPGA_N_NE

The third FPGA. Handles north and north-east.

FPGA_ALL

public static final FPGA FPGA_ALL

All three FPGAs. Note that only a subset of APIs that handle FPGAs will accept this.

Field Details

name

public final String name

The "name" of the FPGA.

value

public final int value

The FPGA identifier in protocol terms.

bits

public final int bits

The bit encoding for read and write requests.

Method Details

values

public static FPGA[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FPGA valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<FPGA>

isSingleFPGA

public boolean isSingleFPGA()

Returns:

Whether this identifies a single FPGA.