xal.smf.impl

Enum WireHarp.CMD

java.lang.Object

java.lang.Enum<WireHarp.CMD>

xal.smf.impl.WireHarp.CMD

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WireHarp.CMD>

Enclosing class:

WireHarp

public static enum WireHarp.CMD
extends java.lang.Enum<WireHarp.CMD>

Wire Scanner Commands

The commands below represent the possible values for the first argument in the command array. It provides the command type while additional arguments provide the command parameters.

Since:

Aug 21, 2009

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASELINE Take a new baseline measurement
NOOP No operation
SECRET The secret command

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HANDLE_CMD Command-issuing handle
static java.lang.String	HANDLE_RESULT command result handle

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns the integer-value device command associated with the command enumeration constant.
static WireHarp.CMD	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WireHarp.CMD[]	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 Detail

NOOP

public static final WireHarp.CMD NOOP

No operation

BASELINE

public static final WireHarp.CMD BASELINE

Take a new baseline measurement

SECRET

public static final WireHarp.CMD SECRET

The secret command

Field Detail

HANDLE_CMD

public static final java.lang.String HANDLE_CMD

Command-issuing handle

See Also:

Constant Field Values

HANDLE_RESULT

public static final java.lang.String HANDLE_RESULT

command result handle

See Also:

Constant Field Values

Method Detail

values

public static WireHarp.CMD[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WireHarp.CMD c : WireHarp.CMD.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WireHarp.CMD valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCode

public int getCode()

Returns the integer-value device command associated with the command enumeration constant.

Returns:

device command for constant

Since:

Aug 21, 2009