xal.smf.impl

Enum WireScanner.CMD

java.lang.Object

java.lang.Enum<WireScanner.CMD>

xal.smf.impl.WireScanner.CMD

All Implemented Interfaces:

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

Enclosing class:

WireScanner

public static enum WireScanner.CMD
extends java.lang.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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static WireScanner.CMD[]	ARR_CMDARG A list of commands which may contain arguments
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.
boolean	hasArgument() Indicates whether or not this command can have arguments.
static WireScanner.CMD	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WireScanner.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 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 Detail

ARR_CMDARG

public static WireScanner.CMD[] ARR_CMDARG

A list of commands which may contain arguments

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 WireScanner.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 (WireScanner.CMD c : WireScanner.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 WireScanner.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

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