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

Enum Class MailboxCommand

java.lang.Object

java.lang.Enum<MailboxCommand>

uk.ac.manchester.spinnaker.messages.model.MailboxCommand

All Implemented Interfaces:

Serializable, Comparable<MailboxCommand>, Constable

public enum MailboxCommand
extends Enum<MailboxCommand>

Commands sent between an application and the monitor processor.

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
SHM_CMD	The mailbox contains a command.
SHM_IDLE	The mailbox is idle.
SHM_MSG	The mailbox contains an SDP message.
SHM_NOP	The mailbox contains a non-operation.
SHM_SIGNAL	The mailbox contains a signal.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	The SARK value.

Method Summary

Modifier and Type	Method	Description
static MailboxCommand	get(int value)	Convert SARK value to enum.
static MailboxCommand	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MailboxCommand[]	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

SHM_IDLE

public static final MailboxCommand SHM_IDLE

The mailbox is idle.

SHM_MSG

public static final MailboxCommand SHM_MSG

The mailbox contains an SDP message.

SHM_NOP

public static final MailboxCommand SHM_NOP

The mailbox contains a non-operation.

SHM_SIGNAL

public static final MailboxCommand SHM_SIGNAL

The mailbox contains a signal.

SHM_CMD

public static final MailboxCommand SHM_CMD

The mailbox contains a command.

Field Details

value

public final int value

The SARK value.

Method Details

values

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

get

public static MailboxCommand get(int value)

Convert SARK value to enum.

Parameters:

value - The value to convert.

Returns:

The enum member