org.lsst.ccs.subsystem.shutter.status

Enum PtpDeviceState

java.lang.Object

java.lang.Enum<PtpDeviceState>

org.lsst.ccs.subsystem.shutter.status.PtpDeviceState

All Implemented Interfaces:

Serializable, Comparable<PtpDeviceState>

public enum PtpDeviceState
extends Enum<PtpDeviceState>

Represents the various states that the EL6688's PTP interface can be in. We normally operate the device as PTPv2 Slave Only so the state transitions would be NO_OPERATION -> INITIALIZING -> LISTENING -> SLAVE.

Author:

tether

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED
FAULTY
INITIALIZING Just got connected to a local network.
LISTENING Listening for PTP packets from a master clock.
MASTER
NO_OPERATION The device has no connection to a network.
PASSIVE
PRE_MASTER
SLAVE Now sync'ed to a master clock.
UNCALIBRATED

Method Summary

Modifier and Type	Method and Description
static PtpDeviceState	fromStateNumber(int n) Converts a raw state number from the device into one of the enum values.
static int	toStateNumber(PtpDeviceState state)
static PtpDeviceState	valueOf(String name) Returns the enum constant of this type with the specified name.
static PtpDeviceState[]	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

NO_OPERATION

public static final PtpDeviceState NO_OPERATION

The device has no connection to a network. Could be caused, for example, by a bad IP address or by bad cabling.

INITIALIZING

public static final PtpDeviceState INITIALIZING

Just got connected to a local network.

FAULTY

public static final PtpDeviceState FAULTY

DISABLED

public static final PtpDeviceState DISABLED

LISTENING

public static final PtpDeviceState LISTENING

Listening for PTP packets from a master clock.

PRE_MASTER

public static final PtpDeviceState PRE_MASTER

MASTER

public static final PtpDeviceState MASTER

PASSIVE

public static final PtpDeviceState PASSIVE

UNCALIBRATED

public static final PtpDeviceState UNCALIBRATED

SLAVE

public static final PtpDeviceState SLAVE

Now sync'ed to a master clock.

Method Detail

values

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

Returns:

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

valueOf

public static PtpDeviceState 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

fromStateNumber

public static PtpDeviceState fromStateNumber(int n)
                                      throws IllegalArgumentException

Converts a raw state number from the device into one of the enum values.

Parameters:

n - the raw state number.

Returns:

A non-null enum value.

Throws:

IllegalArgumentException - if the argument is outside the legal range.

toStateNumber

public static int toStateNumber(PtpDeviceState state)