Package xal.smf.impl

Enum Class WireHarp.CMD

java.lang.Object

java.lang.Enum<WireHarp.CMD>

xal.smf.impl.WireHarp.CMD

All Implemented Interfaces:

Serializable, Comparable<WireHarp.CMD>, Constable

Enclosing class:

WireHarp

public static enum WireHarp.CMD
extends 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

Author:

Christopher K. Allen

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
BASELINE	Take a new baseline measurement
NOOP	No operation
SECRET	The secret command

Field Summary

Fields

Modifier and Type	Field	Description
final AccessibleProperty	cmdResult
final AccessibleProperty	command
static final String	HANDLE_CMD	Command-issuing handle
static final String	HANDLE_RESULT	command result handle

Method Summary

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

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 Details

HANDLE_CMD

public static final String HANDLE_CMD

Command-issuing handle

See Also:

• Constant Field Values

command

public final AccessibleProperty command

HANDLE_RESULT

public static final String HANDLE_RESULT

command result handle

See Also:

• Constant Field Values

cmdResult

public final AccessibleProperty cmdResult

Method Details

values

public static WireHarp.CMD[] 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 WireHarp.CMD 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

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