Channel (LSST CCS - Toolkit (Pom) 5.1.3 API)

java.lang.Object
- org.lsst.ccs.monitor.Channel

```
public class Channel
extends Object
```
Handles a monitoring channel.

Author:

Owen Saxton

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`alarmHi`
`protected String`	`alarmLo`
`protected String`	`checkHi`
`protected String`	`checkLo`
`protected double`	`dbandHi`
`protected double`	`dbandLo`
`protected String`	`description` Data fields.
`protected String`	`devcName`
`protected String`	`format`
`protected int`	`hwChan`
`protected double`	`limitHi`
`protected double`	`limitLo`
`protected double`	`offset`
`protected int`	`pageId`
`protected double`	`scale`
`protected String`	`subtype`
`protected String`	`type`
`static int`	`TYPE_DIFF` Constants.
`static int`	`TYPE_POWER` Constants.
`static int`	`TYPE_PROD` Constants.
`static int`	`TYPE_QUOT` Constants.
`static int`	`TYPE_SUM` Constants.
`static int`	`TYPE_SWITCH` Constants.
`static int`	`TYPE_TEMP` Constants.
`static int`	`TYPE_UNKNOWN` Constants.
`static int`	`TYPE_VOLTS` Constants.
`protected String`	`units`

Constructor Summary

Constructors
Constructor and Description

Channel()

Constructors
Constructor and Description
`Channel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`enableAlarm(boolean isLow, boolean enable)` Enables or disables an alarm.
`String`	`getAlarmNameHi()` Gets the channel high limit alarm name.
`String`	`getAlarmNameLo()` Gets the channel low limit alarm name.
`double`	`getDbandHi()` Gets the channel dead band high.
`double`	`getDbandLo()` Gets the channel dead band low.
`String`	`getDescription()` Gets the channel description.
`Device`	`getDevice()`
`String`	`getFormat()` Gets the display format.
`double`	`getLimitHi()` Gets the channel high limit.
`double`	`getLimitLo()` Gets the channel low limit.
`String`	`getName()`
`int`	`getPageId()` Gets the display page ID.
`String`	`getPath()`
`String`	`getUnits()` Gets the channel units.
`double`	`getValue()` Gets the channel value.
`double`	`readValue()` Reads the value directly from the hardware.
`void`	`setDbandHi(double value)` Sets the high warning offset (formerly deadband)
`void`	`setDbandLo(double value)` Sets the low warning offset (formerly deadband)
`void`	`setFormat(String fmt)` Sets the format string for this Channel.
`void`	`setLimitHi(double limit)` Sets the high limit.
`void`	`setLimitLo(double limit)` Sets the low limit.
`void`	`setValid(boolean isValid)` Sets whether the channel is valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE_UNKNOWN
```
public static final int TYPE_UNKNOWN
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_TEMP
```
public static final int TYPE_TEMP
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_VOLTS
```
public static final int TYPE_VOLTS
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_POWER
```
public static final int TYPE_POWER
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_SWITCH
```
public static final int TYPE_SWITCH
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_SUM
```
public static final int TYPE_SUM
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_DIFF
```
public static final int TYPE_DIFF
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_PROD
```
public static final int TYPE_PROD
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - TYPE_QUOT
```
public static final int TYPE_QUOT
```
    Constants.
    
    See Also:
    
    Constant Field Values
  - description
```
protected String description
```
    Data fields.
  - units
```
protected String units
```
  - devcName
```
protected String devcName
```
  - hwChan
```
protected int hwChan
```
  - type
```
protected String type
```
  - subtype
```
protected String subtype
```
  - offset
```
protected double offset
```
  - scale
```
protected double scale
```
  - checkLo
```
protected String checkLo
```
  - alarmLo
```
protected String alarmLo
```
  - dbandLo
```
@ConfigurationParameter(name="dbandLo",
                        category="Limits")
protected double dbandLo
```
  - checkHi
```
protected String checkHi
```
  - alarmHi
```
protected String alarmHi
```
  - dbandHi
```
@ConfigurationParameter(name="dbandHi",
                        category="Limits")
protected double dbandHi
```
  - pageId
```
protected int pageId
```
  - format
```
protected String format
```
  - limitLo
```
@ConfigurationParameter(name="limitLo",
                        category="Limits")
protected double limitLo
```
  - limitHi
```
@ConfigurationParameter(name="limitHi",
                        category="Limits")
protected double limitHi
```
- Constructor Detail
  - Channel
```
public Channel()
```
- Method Detail
  - setFormat
```
public final void setFormat(String fmt)
```
    Sets the format string for this Channel.
    
    Parameters:
    
    fmt - The provided format to be set
  - setLimitLo
```
@ConfigurationParameterChanger
public void setLimitLo(double limit)
```
    Sets the low limit.
    
    Parameters:
    
    limit - The low limit value to set.
  - setLimitHi
```
@ConfigurationParameterChanger
public void setLimitHi(double limit)
```
    Sets the high limit.
    
    Parameters:
    
    limit - The high limit value to set.
  - setDbandLo
```
@ConfigurationParameterChanger
public void setDbandLo(double value)
```
    Sets the low warning offset (formerly deadband)
    
    Parameters:
    
    value - The value to set
  - setDbandHi
```
@ConfigurationParameterChanger
public void setDbandHi(double value)
```
    Sets the high warning offset (formerly deadband)
    
    Parameters:
    
    value - The value to set
  - getDevice
```
public Device getDevice()
```
  - getDescription
```
public String getDescription()
```
    Gets the channel description.
    
    Returns:
    
    The channel description
  - getFormat
```
public String getFormat()
```
    Gets the display format.
    
    Returns:
    
    The channel description
  - getUnits
```
public String getUnits()
```
    Gets the channel units.
    
    Returns:
    
    The channel units
  - getPageId
```
public int getPageId()
```
    Gets the display page ID.
    
    Returns:
    
    The page ID
  - getLimitLo
```
public double getLimitLo()
```
    Gets the channel low limit.
    
    Returns:
    
    The channel low limit
  - getAlarmNameLo
```
public String getAlarmNameLo()
```
    Gets the channel low limit alarm name.
    
    Returns:
    
    The channel low limit alarm name
  - getLimitHi
```
public double getLimitHi()
```
    Gets the channel high limit.
    
    Returns:
    
    The channel high limit
  - getDbandLo
```
public double getDbandLo()
```
    Gets the channel dead band low.
    
    Returns:
    
    The channel dead band low
  - getDbandHi
```
public double getDbandHi()
```
    Gets the channel dead band high.
    
    Returns:
    
    The channel dead band high
  - getAlarmNameHi
```
public String getAlarmNameHi()
```
    Gets the channel high limit alarm name.
    
    Returns:
    
    The channel high limit alarm name
  - enableAlarm
```
public void enableAlarm(boolean isLow,
                        boolean enable)
```
    Enables or disables an alarm.
    
    Parameters:
    
    isLow - True for low limit alarm, false for high.
    
    enable - True to enable the alarm, false to disable it.
  - getValue
```
@Command(type=QUERY)
public double getValue()
```
    Gets the channel value.
    
    Returns:
    
    The last value successfully read from the channel.
  - setValid
```
public void setValid(boolean isValid)
```
    Sets whether the channel is valid.
    
    Parameters:
    
    isValid - Value to set
  - readValue
```
public double readValue()
```
    Reads the value directly from the hardware.
    
    Returns:
    
    The value read or NaN if the device is offline
  - getPath
```
public String getPath()
```
  - getName
```
public String getName()
```

Class Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_UNKNOWN

TYPE_TEMP

TYPE_VOLTS

TYPE_POWER

TYPE_SWITCH

TYPE_SUM

TYPE_DIFF

TYPE_PROD

TYPE_QUOT

description

units

devcName

hwChan

type

subtype

offset

scale

checkLo

alarmLo

dbandLo

checkHi

alarmHi

dbandHi

pageId

format

limitLo

limitHi

Constructor Detail

Channel

Method Detail

setFormat

setLimitLo

setLimitHi

setDbandLo

setDbandHi

getDevice

getDescription

getFormat

getUnits

getPageId

getLimitLo

getAlarmNameLo

getLimitHi

getDbandLo

getDbandHi

getAlarmNameHi

enableAlarm

getValue

setValid

readValue

getPath

getName