Package uk.ac.manchester.spinnaker.alloc.admin

Enum Class MachineDefinitionLoader.Link

java.lang.Object

java.lang.Enum<MachineDefinitionLoader.Link>

uk.ac.manchester.spinnaker.alloc.admin.MachineDefinitionLoader.Link

All Implemented Interfaces:

Serializable, Comparable<MachineDefinitionLoader.Link>, Constable

Enclosing class:

MachineDefinitionLoader

public static enum MachineDefinitionLoader.Link
extends Enum<MachineDefinitionLoader.Link>

Enumeration of links from a SpiNNaker chip, as used in the old spalloc.

Note that the numbers chosen have two useful properties:

• The integer values assigned are chosen to match the numbers used to identify the links in the low-level software API and hardware registers.
• The links are ordered consecutively in anticlockwise order meaning the opposite link is (link+3)%6.

Note that the new Spalloc uses a different notation for link directions!

Author:

Donal Fellows

See Also:

• Direction

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
east	East.
north	North.
northEast	North-East.
south	South.
southWest	South-West.
west	West.

Method Summary

Modifier and Type	Method	Description
static MachineDefinitionLoader.Link	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MachineDefinitionLoader.Link[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

east

public static final MachineDefinitionLoader.Link east

East.

northEast

public static final MachineDefinitionLoader.Link northEast

North-East.

north

public static final MachineDefinitionLoader.Link north

North.

west

public static final MachineDefinitionLoader.Link west

West.

southWest

public static final MachineDefinitionLoader.Link southWest

South-West.

south

public static final MachineDefinitionLoader.Link south

South.

Method Details

values

public static MachineDefinitionLoader.Link[] 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 MachineDefinitionLoader.Link 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