Package uk.ac.manchester.spinnaker.messages.notification

Enum Class NotificationMessageCode

java.lang.Object

java.lang.Enum<NotificationMessageCode>

uk.ac.manchester.spinnaker.messages.notification.NotificationMessageCode

All Implemented Interfaces:

Serializable, Comparable<NotificationMessageCode>, Constable

public enum NotificationMessageCode
extends Enum<NotificationMessageCode>

What command codes are used in the notification protocol.

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
DATABASE_CONFIRMATION	Database handshake with external program.
START_RESUME_NOTIFICATION	Notify the external devices that the simulation has started.
STOP_PAUSE_NOTIFICATION	Notify the external devices that the simulation has stopped.

Method Summary

Modifier and Type	Method	Description
static NotificationMessageCode	get(int command)	Get a command from an ID.
int	getValue()
static NotificationMessageCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NotificationMessageCode[]	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

DATABASE_CONFIRMATION

public static final NotificationMessageCode DATABASE_CONFIRMATION

Database handshake with external program.

STOP_PAUSE_NOTIFICATION

public static final NotificationMessageCode STOP_PAUSE_NOTIFICATION

Notify the external devices that the simulation has stopped.

START_RESUME_NOTIFICATION

public static final NotificationMessageCode START_RESUME_NOTIFICATION

Notify the external devices that the simulation has started.

Method Details

values

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

getValue

public int getValue()

Returns:

The value of this code.

get

public static NotificationMessageCode get(int command)

Get a command from an ID.

Parameters:

command - the encoded command

Returns:

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