org.lsst.ccs.bus.states

Enum DataProviderState

java.lang.Object

java.lang.Enum<DataProviderState>

org.lsst.ccs.bus.states.DataProviderState

All Implemented Interfaces:

Serializable, Comparable<DataProviderState>

public enum DataProviderState
extends Enum<DataProviderState>
implements Serializable

The DataProviderState of a data provider reflects the current operating conditions of the provider. It takes in consideration interaction with the underlying hardware and the validity of the data against the data validator attached to the data provider, if it exists.

Author:

LSST CCS Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALARM The hardware is online, successfully read, the data validator validates it at ALARM.
DISABLED The hardware is online but it is not being read.
NOMINAL The hardware is online, successfully read and validated by the DataValidator.
NOT_VALIDATED The hardware is online, successfully read, and the data validator is disabled.
OFF_LINE The hardware device is unreachable.
WARNING The hardware is online, successfully read, the data validator validates it at WARNING.

Method Summary

Modifier and Type	Method and Description
static DataProviderState	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataProviderState[]	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

OFF_LINE

public static final DataProviderState OFF_LINE

The hardware device is unreachable.

DISABLED

public static final DataProviderState DISABLED

The hardware is online but it is not being read.

NOT_VALIDATED

public static final DataProviderState NOT_VALIDATED

The hardware is online, successfully read, and the data validator is disabled.

NOMINAL

public static final DataProviderState NOMINAL

The hardware is online, successfully read and validated by the DataValidator.

WARNING

public static final DataProviderState WARNING

The hardware is online, successfully read, the data validator validates it at WARNING.

ALARM

public static final DataProviderState ALARM

The hardware is online, successfully read, the data validator validates it at ALARM.

Method Detail

values

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

Returns:

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

valueOf

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