Package xal.smf.impl

Enum Class WireScanner.CMDARG

java.lang.Object

java.lang.Enum<WireScanner.CMDARG>

xal.smf.impl.WireScanner.CMDARG

All Implemented Interfaces:

Serializable, Comparable<WireScanner.CMDARG>, Constable

Enclosing class:

WireScanner

public static enum WireScanner.CMDARG
extends Enum<WireScanner.CMDARG>

Valid arguments to commands accepting arguments.

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
FWD	Hit command argument: Forward
NONE	Update command argument 1: None
OFF	Brake command argument: turn the brake off
ON	Brake command argument: turn the brake on
PROF	Update command argument 1: Profile
PT	Update command argument 1: Point (live data update)
REV	Hit command argument: Reverse
SETUPDAQ	Load Parameters
TRACE	Update command argument 1: Trace

Method Summary

Modifier and Type	Method	Description
int	getArgCode()	Returns the integer-value command argument associated with the (CMD,ARG) pair.
WireScanner.CMD	getCommand()	Returns the integer-value device command associated with the (CMD,ARG) pair.
static WireScanner.CMDARG	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WireScanner.CMDARG[]	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

OFF

public static final WireScanner.CMDARG OFF

Brake command argument: turn the brake off

ON

public static final WireScanner.CMDARG ON

Brake command argument: turn the brake on

REV

public static final WireScanner.CMDARG REV

Hit command argument: Reverse

FWD

public static final WireScanner.CMDARG FWD

Hit command argument: Forward

SETUPDAQ

public static final WireScanner.CMDARG SETUPDAQ

Load Parameters

NONE

public static final WireScanner.CMDARG NONE

Update command argument 1: None

PT

public static final WireScanner.CMDARG PT

Update command argument 1: Point (live data update)

TRACE

public static final WireScanner.CMDARG TRACE

Update command argument 1: Trace

PROF

public static final WireScanner.CMDARG PROF

Update command argument 1: Profile

Method Details

values

public static WireScanner.CMDARG[] 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 WireScanner.CMDARG 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

getCommand

public WireScanner.CMD getCommand()

Returns the integer-value device command associated with the (CMD,ARG) pair.

Returns:

device command for enumeration constant

Since:

Aug 21, 2009

getArgCode

public int getArgCode()

Returns the integer-value command argument associated with the (CMD,ARG) pair.

Returns:

command argument for enumeration constant

Since:

Aug 21, 2009