Package uk.ac.manchester.spinnaker.messages.eieio

Enum EIEIOCommandID

java.lang.Object

java.lang.Enum<EIEIOCommandID>

uk.ac.manchester.spinnaker.messages.eieio.EIEIOCommandID

All Implemented Interfaces:

Serializable, Comparable<EIEIOCommandID>, EIEIOCommand

public enum EIEIOCommandID
extends Enum<EIEIOCommandID>
implements EIEIOCommand

What SpiNNaker-specific EIEIO commands there are.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EVENT_PADDING	Fill in buffer area with padding.
EVENT_STOP	End of all buffers, stop execution.
HOST_DATA_READ	Host confirming data being read form SpiNNaker memory.
HOST_DATA_READ_ACK	Host confirming request to read data received.
HOST_SEND_SEQUENCED_DATA	Buffers being sent from host to SpiNNaker.
SPINNAKER_REQUEST_BUFFERS	Spinnaker requesting new buffers for spike source population.
SPINNAKER_REQUEST_READ_DATA	Buffers available to be read from a buffered out vertex.
START_SENDING_REQUESTS	Start complaining that there is SDRAM free space for buffers.
STOP_SENDING_REQUESTS	Stop complaining that there is SDRAM free space for buffers.

Method Summary

Modifier and Type	Method	Description
static EIEIOCommand	get(int command)	Get a command given its encoded form.
int	getValue()	Get the encoded ID number of the command.
static EIEIOCommandID	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EIEIOCommandID[]	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

EVENT_PADDING

public static final EIEIOCommandID EVENT_PADDING

Fill in buffer area with padding.

EVENT_STOP

public static final EIEIOCommandID EVENT_STOP

End of all buffers, stop execution.

STOP_SENDING_REQUESTS

public static final EIEIOCommandID STOP_SENDING_REQUESTS

Stop complaining that there is SDRAM free space for buffers.

START_SENDING_REQUESTS

public static final EIEIOCommandID START_SENDING_REQUESTS

Start complaining that there is SDRAM free space for buffers.

SPINNAKER_REQUEST_BUFFERS

public static final EIEIOCommandID SPINNAKER_REQUEST_BUFFERS

Spinnaker requesting new buffers for spike source population.

HOST_SEND_SEQUENCED_DATA

public static final EIEIOCommandID HOST_SEND_SEQUENCED_DATA

Buffers being sent from host to SpiNNaker.

SPINNAKER_REQUEST_READ_DATA

public static final EIEIOCommandID SPINNAKER_REQUEST_READ_DATA

Buffers available to be read from a buffered out vertex.

HOST_DATA_READ

public static final EIEIOCommandID HOST_DATA_READ

Host confirming data being read form SpiNNaker memory.

HOST_DATA_READ_ACK

public static final EIEIOCommandID HOST_DATA_READ_ACK

Host confirming request to read data received.

Method Details

values

public static EIEIOCommandID[] 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 EIEIOCommandID 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

getValue

public int getValue()

Description copied from interface: EIEIOCommand

Get the encoded ID number of the command.

Specified by:

getValue in interface EIEIOCommand

Returns:

The encoded form.

get

public static EIEIOCommand get(int command)

Get a command given its encoded form.

Parameters:

command - the encoded command

Returns:

the ID, or null if the encoded form was unrecognised.