DoorChannel (LSST CCS - Doorman Subsystem (Pom) 1.0.1 API)

java.lang.Object
- java.lang.Enum<DoorChannel>
- - org.lsst.ccs.subsystem.doorman.main.DoorChannel

All Implemented Interfaces:

Serializable, Comparable<DoorChannel>
```
public enum DoorChannel
extends Enum<DoorChannel>
```
The quantities monitored by each instrument. Modbus holding register numbers have 40000 subtracted, while coil numbers have 10000 subtracted.

Author:

tether

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AIR_OUTLET_TEMP` Air supply outlet temperature.
`B4_ALARM` Probe B4 alarm.
`CLOCK_ALARM` Clock board alarm.
`CLOCK_DAY` Door clock day.
`CLOCK_HOUR` Door clock hour.
`CLOCK_MINUTE` Door clock minute.
`CLOCK_MONTH` Door clock month.
`CLOCK_YEAR` Door clock year.
`DOOR_OPEN` The unit door is open.
`FAN1_ALARM` Fan 1 speed alarm.
`FAN1_SPEED` Speed of fan 1 in RPM.
`FAN2_ALARM` Fan 1 speed alarm.
`FAN2_SPEED` Speed of fan 1 in RPM.
`FAN3_ALARM` Fan 1 speed alarm.
`FAN3_SPEED` Speed of fan 1 in RPM.
`FAN4_ALARM` Fan 1 speed alarm.
`FAN4_SPEED` Speed of fan 1 in RPM.
`FAN5_ALARM` Fan 1 speed alarm.
`FAN5_SPEED` Speed of fan 1 in RPM.
`GENERAL_ALARM` General alarm output.
`HIGH_AIR_TEMP` High air temperature alarm.
`HIGH_FAN_PRESSURE` Fan high pressure alarm.
`HIGH_ROOM_TEMP` High room temperature.
`HIGH_SERVER_OUTLET_TEMP` High server outlet temp.
`HIGH_WATER_TEMP` High water temperature alarm.
`LOW_AIR_SUPPLY_TEMP` Low temperature in the air supply.
`LOW_ROOM_TEMP` Low room temperature.
`LOW_WATER_TEMP` Low water temperature alarm.
`RETURN_WATER_TEMP` The return-water coil temperature.
`ROOM_TEMP` The room temperature.
`SERVER_OUTLET_AIR_TEMP` The server outlet air temperature.
`UNIT_STATE` Unit state: 0 for off, 1 for on.
`VALVE_OUTPUT` Valve output signal expressed as a percentage.
`WATER_DETECTED` Water detected (condensation?) alarm.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getKey()` Gets the trending key used to identify the channel.
`int`	`getRegister()` Gets the Modbus register number.
`DoorChannelType`	`getType()` Gets the channel type.
`static Optional<DoorChannel>`	`parse(String key)` Converts a trending key string into the corresponding channel.
`static DoorChannel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DoorChannel[]`	`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
  - AIR_OUTLET_TEMP
```
public static final DoorChannel AIR_OUTLET_TEMP
```
    Air supply outlet temperature.
  - RETURN_WATER_TEMP
```
public static final DoorChannel RETURN_WATER_TEMP
```
    The return-water coil temperature.
  - VALVE_OUTPUT
```
public static final DoorChannel VALVE_OUTPUT
```
    Valve output signal expressed as a percentage.
  - ROOM_TEMP
```
public static final DoorChannel ROOM_TEMP
```
    The room temperature.
  - SERVER_OUTLET_AIR_TEMP
```
public static final DoorChannel SERVER_OUTLET_AIR_TEMP
```
    The server outlet air temperature.
  - FAN1_SPEED
```
public static final DoorChannel FAN1_SPEED
```
    Speed of fan 1 in RPM.
  - FAN2_SPEED
```
public static final DoorChannel FAN2_SPEED
```
    Speed of fan 1 in RPM.
  - FAN3_SPEED
```
public static final DoorChannel FAN3_SPEED
```
    Speed of fan 1 in RPM.
  - FAN4_SPEED
```
public static final DoorChannel FAN4_SPEED
```
    Speed of fan 1 in RPM.
  - FAN5_SPEED
```
public static final DoorChannel FAN5_SPEED
```
    Speed of fan 1 in RPM.
  - CLOCK_DAY
```
public static final DoorChannel CLOCK_DAY
```
    Door clock day.
  - CLOCK_MONTH
```
public static final DoorChannel CLOCK_MONTH
```
    Door clock month.
  - CLOCK_YEAR
```
public static final DoorChannel CLOCK_YEAR
```
    Door clock year.
  - CLOCK_HOUR
```
public static final DoorChannel CLOCK_HOUR
```
    Door clock hour.
  - CLOCK_MINUTE
```
public static final DoorChannel CLOCK_MINUTE
```
    Door clock minute.
  - HIGH_AIR_TEMP
```
public static final DoorChannel HIGH_AIR_TEMP
```
    High air temperature alarm.
  - HIGH_WATER_TEMP
```
public static final DoorChannel HIGH_WATER_TEMP
```
    High water temperature alarm.
  - LOW_WATER_TEMP
```
public static final DoorChannel LOW_WATER_TEMP
```
    Low water temperature alarm.
  - UNIT_STATE
```
public static final DoorChannel UNIT_STATE
```
    Unit state: 0 for off, 1 for on.
  - WATER_DETECTED
```
public static final DoorChannel WATER_DETECTED
```
    Water detected (condensation?) alarm.
  - GENERAL_ALARM
```
public static final DoorChannel GENERAL_ALARM
```
    General alarm output.
  - CLOCK_ALARM
```
public static final DoorChannel CLOCK_ALARM
```
    Clock board alarm.
  - HIGH_ROOM_TEMP
```
public static final DoorChannel HIGH_ROOM_TEMP
```
    High room temperature.
  - LOW_ROOM_TEMP
```
public static final DoorChannel LOW_ROOM_TEMP
```
    Low room temperature.
  - FAN1_ALARM
```
public static final DoorChannel FAN1_ALARM
```
    Fan 1 speed alarm.
  - FAN2_ALARM
```
public static final DoorChannel FAN2_ALARM
```
    Fan 1 speed alarm.
  - FAN3_ALARM
```
public static final DoorChannel FAN3_ALARM
```
    Fan 1 speed alarm.
  - FAN4_ALARM
```
public static final DoorChannel FAN4_ALARM
```
    Fan 1 speed alarm.
  - FAN5_ALARM
```
public static final DoorChannel FAN5_ALARM
```
    Fan 1 speed alarm.
  - HIGH_SERVER_OUTLET_TEMP
```
public static final DoorChannel HIGH_SERVER_OUTLET_TEMP
```
    High server outlet temp.
  - HIGH_FAN_PRESSURE
```
public static final DoorChannel HIGH_FAN_PRESSURE
```
    Fan high pressure alarm.
  - B4_ALARM
```
public static final DoorChannel B4_ALARM
```
    Probe B4 alarm.
  - LOW_AIR_SUPPLY_TEMP
```
public static final DoorChannel LOW_AIR_SUPPLY_TEMP
```
    Low temperature in the air supply.
  - DOOR_OPEN
```
public static final DoorChannel DOOR_OPEN
```
    The unit door is open.
- Method Detail
  - values
```
public static DoorChannel[] 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 (DoorChannel c : DoorChannel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DoorChannel 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
  - getKey
```
public String getKey()
```
    Gets the trending key used to identify the channel.
    
    Returns:
    
    The key.
  - getType
```
public DoorChannelType getType()
```
    Gets the channel type.
    
    Returns:
    
    The type enumerator.
  - getRegister
```
public int getRegister()
```
    Gets the Modbus register number.
    
    Returns:
    
    The register number.
  - parse
```
public static Optional<DoorChannel> parse(String key)
```
    Converts a trending key string into the corresponding channel.
    
    Parameters:
    
    key - The trending key.
    
    Returns:
    
    An empty Optional if the key is invalid, otherwise an Optional holding the enum value.

Enum DoorChannel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AIR_OUTLET_TEMP

RETURN_WATER_TEMP

VALVE_OUTPUT

ROOM_TEMP

SERVER_OUTLET_AIR_TEMP

FAN1_SPEED

FAN2_SPEED

FAN3_SPEED

FAN4_SPEED

FAN5_SPEED

CLOCK_DAY

CLOCK_MONTH

CLOCK_YEAR

CLOCK_HOUR

CLOCK_MINUTE

HIGH_AIR_TEMP

HIGH_WATER_TEMP

LOW_WATER_TEMP

UNIT_STATE

WATER_DETECTED

GENERAL_ALARM

CLOCK_ALARM

HIGH_ROOM_TEMP

LOW_ROOM_TEMP

FAN1_ALARM

FAN2_ALARM

FAN3_ALARM

FAN4_ALARM

FAN5_ALARM

HIGH_SERVER_OUTLET_TEMP

HIGH_FAN_PRESSURE

B4_ALARM

LOW_AIR_SUPPLY_TEMP

DOOR_OPEN

Method Detail

values

valueOf

getKey

getType

getRegister

parse