Package uk.ac.manchester.spinnaker.protocols

Enum Class FastDataInCommandID

java.lang.Object

java.lang.Enum<FastDataInCommandID>

uk.ac.manchester.spinnaker.protocols.FastDataInCommandID

All Implemented Interfaces:

Serializable, Comparable<FastDataInCommandID>, Constable

public enum FastDataInCommandID
extends Enum<FastDataInCommandID>

Command IDs for the SDP packets for data in.

Author:

Donal Fellows

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
RECEIVE_FINISHED_DATA_IN	Gatherer to host: all present and correct.
RECEIVE_MISSING_SEQ_DATA_IN	Gatherer to host: there are missing sequence numbers.
SEND_DATA_TO_LOCATION	Host to Gatherer: start accepting data bound for location.
SEND_SEQ_DATA	Host to Gatherer: more data with sequence number.
SEND_TELL_DATA_IN	Host to Gatherer: all data transmitted.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	The protocol ID of this constant.

Method Summary

Modifier and Type	Method	Description
static FastDataInCommandID	forValue(int value)	Get a constant by its protocol ID.
static FastDataInCommandID	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FastDataInCommandID[]	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

SEND_DATA_TO_LOCATION

public static final FastDataInCommandID SEND_DATA_TO_LOCATION

Host to Gatherer: start accepting data bound for location.

SEND_SEQ_DATA

public static final FastDataInCommandID SEND_SEQ_DATA

Host to Gatherer: more data with sequence number.

SEND_TELL_DATA_IN

public static final FastDataInCommandID SEND_TELL_DATA_IN

Host to Gatherer: all data transmitted.

RECEIVE_MISSING_SEQ_DATA_IN

public static final FastDataInCommandID RECEIVE_MISSING_SEQ_DATA_IN

Gatherer to host: there are missing sequence numbers.

RECEIVE_FINISHED_DATA_IN

public static final FastDataInCommandID RECEIVE_FINISHED_DATA_IN

Gatherer to host: all present and correct.

Field Details

value

public final int value

The protocol ID of this constant.

Method Details

values

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

forValue

public static FastDataInCommandID forValue(int value)

Get a constant by its protocol ID.

Parameters:

value - The protocol ID

Returns:

The matching constant.

Throws:

IllegalArgumentException - if the value isn't one of the ones accepted by this class.