Package xal.smf.impl.profile

Enum Class ProfileDevice.MVTVAL

java.lang.Object

java.lang.Enum<ProfileDevice.MVTVAL>

xal.smf.impl.profile.ProfileDevice.MVTVAL

All Implemented Interfaces:

Serializable, Comparable<ProfileDevice.MVTVAL>, Constable

Enclosing class:

ProfileDevice

public static enum ProfileDevice.MVTVAL
extends Enum<ProfileDevice.MVTVAL>

Enumeration of the various motion states. That is, the values of DevStatus#mvtStatus.

Since:

Jan 22, 2010

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
FAILURE	General motion failure
MOVING	Scan actuator is moving
STATIONARY	Scan actuator is stationary
UNDEFINED	Unknown or undefined motion code, usually indicates error condition

Method Summary

Modifier and Type	Method	Description
int	getMotionCode()	Return the value of the movement state that this enumeration constant represents.
static ProfileDevice.MVTVAL	getMvtFromCode(int intMvt)	Returns the movement enumeration constant for the given movement code value.
static ProfileDevice.MVTVAL	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProfileDevice.MVTVAL[]	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

UNDEFINED

public static final ProfileDevice.MVTVAL UNDEFINED

Unknown or undefined motion code, usually indicates error condition

STATIONARY

public static final ProfileDevice.MVTVAL STATIONARY

Scan actuator is stationary

MOVING

public static final ProfileDevice.MVTVAL MOVING

Scan actuator is moving

FAILURE

public static final ProfileDevice.MVTVAL FAILURE

General motion failure

Method Details

values

public static ProfileDevice.MVTVAL[] 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 ProfileDevice.MVTVAL 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

getMotionCode

public int getMotionCode()

Return the value of the movement state that this enumeration constant represents.

Returns:

motion state value for this enumeration value

Since:

Jan 22, 2010

getMvtFromCode

public static ProfileDevice.MVTVAL getMvtFromCode(int intMvt)

Returns the movement enumeration constant for the given movement code value.

Parameters:

intMvt - code of the movement indicator

Returns:

corresponding movement enumeration constant for given code, or UNDEFINED if value has no constant

Since:

Dec 22, 2009