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

Enum P2PTableRoute

java.lang.Object

java.lang.Enum<P2PTableRoute>

uk.ac.manchester.spinnaker.messages.model.P2PTableRoute

All Implemented Interfaces:

Serializable, Comparable<P2PTableRoute>

public enum P2PTableRoute
extends Enum<P2PTableRoute>

P2P Routing table routes.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EAST	Toward the East chip.
MONITOR	Route to the monitor on the current chip.
NONE	No route to this chip.
NORTH	Toward the North chip.
NORTH_EAST	Toward the North East chip.
SOUTH	Toward the South chip.
SOUTH_WEST	Toward the South West chip.
WEST	Toward the West chip.

Field Summary

Fields

Modifier and Type	Field	Description
int	value	The SpiNNaker value.

Method Summary

Modifier and Type	Method	Description
static P2PTableRoute	get(int value)	Get a route descriptor from its encoded form.
static P2PTableRoute	valueOf(String name)	Returns the enum constant of this type with the specified name.
static P2PTableRoute[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EAST

public static final P2PTableRoute EAST

Toward the East chip. (x+1,y)

NORTH_EAST

public static final P2PTableRoute NORTH_EAST

Toward the North East chip. (x+1,y+1)

NORTH

public static final P2PTableRoute NORTH

Toward the North chip. (x,y+1)

WEST

public static final P2PTableRoute WEST

Toward the West chip. (x-1,y)

SOUTH_WEST

public static final P2PTableRoute SOUTH_WEST

Toward the South West chip. (x-1,y-1)

SOUTH

public static final P2PTableRoute SOUTH

Toward the South chip. (x,y-1)

NONE

public static final P2PTableRoute NONE

No route to this chip.

MONITOR

public static final P2PTableRoute MONITOR

Route to the monitor on the current chip.

Field Details

value

public final int value

The SpiNNaker value.

Method Details

values

public static P2PTableRoute[] values()

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

Returns:

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

valueOf

public static P2PTableRoute valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

get

public static P2PTableRoute get(int value)

Get a route descriptor from its encoded form.

Parameters:

value - The encoded form.

Returns:

The route descriptor.