Package xal.smf.impl

Enum Class WireScanner.CMD

java.lang.Object

java.lang.Enum<WireScanner.CMD>

xal.smf.impl.WireScanner.CMD

All Implemented Interfaces:

Serializable, Comparable<WireScanner.CMD>, Constable

Enclosing class:

WireScanner

public static enum WireScanner.CMD
extends Enum<WireScanner.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
ABORT	Abort the scan (retracts the fork)
ACQUIRE	Acquire data
BRAKE	Turn the brake on or off (normally done automatically)
EZ_SCAN	Performs a (simple) scan using predefined scan parameters within the device controller
HIT	Move until a limit switch is hit (takes arguments 1: forward, 0: reverse)
MOVE	Move the fork a relative position (in micrometers)
NOOP	No operation
PARK	Park the fork
REANALYZE	Recreate the traces and profile points and re-fit to the new profiles (needed after modifying for example the delay parameter).
RESET	Readout settings and set hardware
SAVE	Locally save data
SETUPDAQ	Load the DAQ parameters
SETUPSCAN	Load the motion parameters
STOP	Stop the scan (keeps fork inserted)
UPDATE	Update a particular PV with acquired data or analyzed results.
XPRT_SCAN	Start the scan using the scan parameters specified by the user

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.
boolean	hasArgument()	Indicates whether or not this command can have arguments.
static WireScanner.CMD	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WireScanner.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 WireScanner.CMD NOOP

No operation

RESET

public static final WireScanner.CMD RESET

Readout settings and set hardware

ABORT

public static final WireScanner.CMD ABORT

Abort the scan (retracts the fork)

XPRT_SCAN

public static final WireScanner.CMD XPRT_SCAN

Start the scan using the scan parameters specified by the user

STOP

public static final WireScanner.CMD STOP

Stop the scan (keeps fork inserted)

PARK

public static final WireScanner.CMD PARK

Park the fork

ACQUIRE

public static final WireScanner.CMD ACQUIRE

Acquire data

MOVE

public static final WireScanner.CMD MOVE

Move the fork a relative position (in micrometers)

BRAKE

public static final WireScanner.CMD BRAKE

Turn the brake on or off (normally done automatically)

SETUPSCAN

public static final WireScanner.CMD SETUPSCAN

Load the motion parameters

SETUPDAQ

public static final WireScanner.CMD SETUPDAQ

Load the DAQ parameters

HIT

public static final WireScanner.CMD HIT

Move until a limit switch is hit (takes arguments 1: forward, 0: reverse)

SAVE

public static final WireScanner.CMD SAVE

Locally save data

REANALYZE

public static final WireScanner.CMD REANALYZE

Recreate the traces and profile points and re-fit to the new profiles (needed after modifying for example the delay parameter).

UPDATE

public static final WireScanner.CMD UPDATE

Update a particular PV with acquired data or analyzed results.

EZ_SCAN

public static final WireScanner.CMD EZ_SCAN

Performs a (simple) scan using predefined scan parameters within the device controller

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 WireScanner.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 WireScanner.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

hasArgument

public boolean hasArgument()

Indicates whether or not this command can have arguments.

Returns:

true if this command can have arguments, false false otherwise.

Since:

May 21, 2010