DataChannel (LSST CCS - LighthouseDriver 1.0.1 API)

java.lang.Object
- java.lang.Enum<DataChannel>
- - org.lsst.ccs.drivers.lighthouse.DataChannel

All Implemented Interfaces:

Serializable, Comparable<DataChannel>
```
public enum DataChannel
extends Enum<DataChannel>
```
The data channels we can read from a Lighthouse counter. For each channel the instrument keeps several fields such as value, units, flags, etc. For each such field it has an array we can read with one element per channel. Each element consists of N 16-bit registers where N depends on the type of the field. The channel index, I, assigned to each member of this enum is used to index these arrays: regAddress = I * N + arrayBaseAddress.
The device stores analog values as IEEE single floats and digital values as ints, hence we need isAnalog().
The device allows for 16 possible counter channels followed by 16 possible analog channels.

Author:

tether

Enum Constant Summary

Enum Constants
Enum Constant and Description
`COUNTER_0_3` Counter of 0.3-micron and larger particles.
`COUNTER_0_5` Counter of 0.5-micron and larger particles.
`COUNTER_1_0` Counter of 1-micron and larger particles.
`COUNTER_10_0` Counter of 10-micron and larger particles.
`COUNTER_2_5` Counter of 2.5-micron and larger particles.
`COUNTER_5_0` Counter of 5-micron and larger particles.
`HUMID` Ambient humidity probe.
`TEMP` Ambient temperature probe.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getIndex()` Gets the index of the channel.
`String`	`getName()` Gets the name of the channel.
`ChannelType`	`getType()` Gets the type of quantity measured.
`boolean`	`isAnalog()` Is this an analog channel?
`static DataChannel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DataChannel[]`	`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 DataChannel COUNTER_0_3
```
    Counter of 0.3-micron and larger particles.
  - COUNTER_0_5
```
public static final DataChannel COUNTER_0_5
```
    Counter of 0.5-micron and larger particles.
  - COUNTER_1_0
```
public static final DataChannel COUNTER_1_0
```
    Counter of 1-micron and larger particles.
  - COUNTER_2_5
```
public static final DataChannel COUNTER_2_5
```
    Counter of 2.5-micron and larger particles.
  - COUNTER_5_0
```
public static final DataChannel COUNTER_5_0
```
    Counter of 5-micron and larger particles.
  - COUNTER_10_0
```
public static final DataChannel COUNTER_10_0
```
    Counter of 10-micron and larger particles.
  - TEMP
```
public static final DataChannel TEMP
```
    Ambient temperature probe.
  - HUMID
```
public static final DataChannel HUMID
```
    Ambient humidity probe.
- Method Detail
  - values
```
public static DataChannel[] 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 (DataChannel c : DataChannel.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DataChannel 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
  - getIndex
```
public int getIndex()
```
    Gets the index of the channel.
    
    Returns:
    
    The index.
  - getType
```
public ChannelType getType()
```
    Gets the type of quantity measured.
    
    Returns:
    
    The type.
  - getName
```
public String getName()
```
    Gets the name of the channel.
    
    Returns:
    
    The name.
  - isAnalog
```
public boolean isAnalog()
```
    Is this an analog channel?
    
    Returns:
    
    The flag.

Enum DataChannel

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_5_0

COUNTER_10_0

TEMP

HUMID

Method Detail

values

valueOf

getIndex

getType

getName

isAnalog