org.lsst.ccs.subsystem.shutter.common

Enum PLCError

java.lang.Object

java.lang.Enum<PLCError>

org.lsst.ccs.subsystem.shutter.common.PLCError

All Implemented Interfaces:

Serializable, Comparable<PLCError>

public enum PLCError
extends Enum<PLCError>

Enumerates all the error conditions that may be signaled by an Error message from the PLC. The Error message has a 32-bit mask with one bit for each possible error.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
AXIS_DISABLED Can't move a disabled axis.
BRAKE_SET Axis brake set, can't move.
DEPLOYED_LIMIT Hit motion limit near the deployed (fully extended) position.
HALL_DIFF Hall transition position and encoder position differ too much.
HOME_LIMIT Hit motion limit near home position.
MOTION_VETO Hardware protection logic veto is in effect, can't move.
NOT_HOMED Axis must be homed first.
SHORT_EXPOSURE Exposure time was too short.
TOO_FAST
UNSAFE_MOVE

Method Summary

Modifier and Type	Method and Description
static Set<PLCError>	copyOf(Set<PLCError> errors) Copy a set of PLCError.
static Set<PLCError>	decodeMask(int mask) Create a set of PLCError containing all values whose bit is set in the error mask given.
static int	encodeMask(Set<PLCError> errors) Creates an int with one bit set for each element present in the given set of errors.
int	getBitnum() Gets the bit position of this error in an int error mask.
String	getDescription() Get the description of the error.
static PLCError	valueOf(String name) Returns the enum constant of this type with the specified name.
static PLCError[]	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

MOTION_VETO

public static final PLCError MOTION_VETO

Hardware protection logic veto is in effect, can't move.

BRAKE_SET

public static final PLCError BRAKE_SET

Axis brake set, can't move.

HALL_DIFF

public static final PLCError HALL_DIFF

Hall transition position and encoder position differ too much.

SHORT_EXPOSURE

public static final PLCError SHORT_EXPOSURE

Exposure time was too short.

NOT_HOMED

public static final PLCError NOT_HOMED

Axis must be homed first.

HOME_LIMIT

public static final PLCError HOME_LIMIT

Hit motion limit near home position.

DEPLOYED_LIMIT

public static final PLCError DEPLOYED_LIMIT

Hit motion limit near the deployed (fully extended) position.

UNSAFE_MOVE

public static final PLCError UNSAFE_MOVE

TOO_FAST

public static final PLCError TOO_FAST

AXIS_DISABLED

public static final PLCError AXIS_DISABLED

Can't move a disabled axis.

Method Detail

values

public static PLCError[] 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 (PLCError c : PLCError.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PLCError valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getBitnum

public int getBitnum()

Gets the bit position of this error in an int error mask.

Returns:

The bit position (0-31).

getDescription

public String getDescription()

Get the description of the error.

Returns:

The short description string.

decodeMask

public static Set<PLCError> decodeMask(int mask)

Create a set of PLCError containing all values whose bit is set in the error mask given.

Parameters:

mask - Has a one bit for each error present.

Returns:

The set of PLCError.

encodeMask

public static int encodeMask(Set<PLCError> errors)

Creates an int with one bit set for each element present in the given set of errors.

Parameters:

errors - The set of errors.

Returns:

The error bit-mask.

copyOf

public static Set<PLCError> copyOf(Set<PLCError> errors)

Copy a set of PLCError. Gets around a shortcoming of Enum.copyOf() when the argument isn't an EnumSet.

Parameters:

errors - The set of errors to copy.

Returns: