InstrumentChannel (LSST CCS - Airwatch Subsystem (Pom) 1.1.5 API)

java.lang.Object
- java.lang.Enum<InstrumentChannel>
- - org.lsst.ccs.subsystem.airwatch.main.InstrumentChannel

All Implemented Interfaces:

Serializable, Comparable<InstrumentChannel>
```
public enum InstrumentChannel
extends Enum<InstrumentChannel>
```
The quantities that may be monitored by each instrument.

Author:

tether

Enum Constant Summary

Enum Constants
Enum Constant and Description
`COUNTER_0_3` The count of all particles of size 0.3 microns or larger.
`COUNTER_0_5` The count of all particles of size 0.5 microns or larger.
`COUNTER_1_0` The count of all particles of size 1.0 microns or larger.
`COUNTER_10_0` The count of all particles of size 10.0 microns or larger.
`COUNTER_2_5` The count of all particles of size 2.5 microns or larger.
`COUNTER_3_0` The count of all particles of size 3.0 microns or larger.
`COUNTER_5_0` The count of all particles of size 5.0 microns or larger.
`HUMIDITY` The relative humidity expressed as a percentage.
`TEMPERATURE` The temperature in degrees Fahrenheit.

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.
`boolean`	`isParticleChannel()` Determines whether a channel is a particle count.
`static Optional<InstrumentChannel>`	`parse(String key)` Converts a trending key string into the corresponding channel.
`static InstrumentChannel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static InstrumentChannel[]`	`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
  - COUNTER_0_3
```
public static final InstrumentChannel COUNTER_0_3
```
    The count of all particles of size 0.3 microns or larger.
  - COUNTER_0_5
```
public static final InstrumentChannel COUNTER_0_5
```
    The count of all particles of size 0.5 microns or larger.
  - COUNTER_1_0
```
public static final InstrumentChannel COUNTER_1_0
```
    The count of all particles of size 1.0 microns or larger.
  - COUNTER_2_5
```
public static final InstrumentChannel COUNTER_2_5
```
    The count of all particles of size 2.5 microns or larger.
  - COUNTER_3_0
```
public static final InstrumentChannel COUNTER_3_0
```
    The count of all particles of size 3.0 microns or larger.
  - COUNTER_5_0
```
public static final InstrumentChannel COUNTER_5_0
```
    The count of all particles of size 5.0 microns or larger.
  - COUNTER_10_0
```
public static final InstrumentChannel COUNTER_10_0
```
    The count of all particles of size 10.0 microns or larger.
  - TEMPERATURE
```
public static final InstrumentChannel TEMPERATURE
```
    The temperature in degrees Fahrenheit.
  - HUMIDITY
```
public static final InstrumentChannel HUMIDITY
```
    The relative humidity expressed as a percentage.
- Method Detail
  - values
```
public static InstrumentChannel[] 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 (InstrumentChannel c : InstrumentChannel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static InstrumentChannel 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.
  - isParticleChannel
```
public boolean isParticleChannel()
```
    Determines whether a channel is a particle count.
    
    Returns:
    
    The boolean flag.
  - parse
```
public static Optional<InstrumentChannel> 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 InstrumentChannel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

COUNTER_0_3

COUNTER_0_5

COUNTER_1_0

COUNTER_2_5

COUNTER_3_0

COUNTER_5_0

COUNTER_10_0

TEMPERATURE

HUMIDITY

Method Detail

values

valueOf

getKey

isParticleChannel

parse