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

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

All Implemented Interfaces:

ConfigurationBulkChangeHandler, HasConfigurationParameterDescription, HasLifecycle

Direct Known Subclasses:

DerivedChannel
```
public class Channel
extends Object
implements HasLifecycle, ConfigurationBulkChangeHandler, HasConfigurationParameterDescription
```
Handles a monitoring channel.

Author:

Owen Saxton

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`alarmHi`
`protected Alarm`	`alarmHiA`
`protected String`	`alarmLo`
`protected Alarm`	`alarmLoA`
`protected String`	`checkHi`
`protected String`	`checkLo`
`protected String`	`description` Data fields.
`protected String`	`devcName`
`protected boolean`	`doNotPublish`
`protected boolean`	`doNotTrend`
`protected String`	`format`
`protected int`	`hwChan`
`protected double`	`hysteresis`
`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 int`	`typeI`
`protected String`	`units`
`protected double`	`warnHi`
`protected double`	`warnLo`

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`	`build()` First lifecycle hook.
`double`	`convertRawValue(double rawValue)` Convert a raw value by applying this Channel's offset and scale factors.
`ConfigurationParameterDescription`	`getConfigurationParameterDescription(String parName)` Get a custom ConfigurationParameterDescription for the specified parameter name.
`String`	`getDescription()` Gets the channel description.
`Device`	`getDevice()` Gets the Device associated with this Channel
`String`	`getFormat()` Gets the display format.
`String`	`getGroup()`
`int`	`getHwChan()` Gets the Hardware Channel
`double`	`getHysteresisLimitHi()` Gets the channel hysteresis high limit.
`double`	`getHysteresisLimitLo()` Gets the channel hysteresis low limit.
`double`	`getHysteresisWarnHi()` Gets the channel hysteresis high warning level
`double`	`getHysteresisWarnLo()` Gets the channel hysteresis low warning level
`int`	`getId()` Gets the channel ID.
`Measurement`	`getLastMeasurement()` Gets the last Measurement: a CCSTimeStamp, double pair
`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()`
`int`	`getSubType()`
`String`	`getSubTypeStr()`
`int`	`getType()`
`String`	`getTypeStr()`
`String`	`getUnits()` Gets the channel units.
`double`	`getValue()` Gets the channel value.
`double`	`getWarnHi()` Gets the channel high warning level
`double`	`getWarnLo()` Gets the channel low warning level
`boolean`	`hasHysteresis()` Returns whether this channel has hysteresis
`void`	`init()` Called from the enclosing `Subsystem` at initialization phase.
`double`	`readValue()` Reads the value directly from the hardware.
`void`	`setParameterBulk(Map<String,Object> params)` Set configuration parameters to new values and compute (derived) quantities (for hysteresis, etc.)
`void`	`validateBulkChange(Map<String,Object> params)` Checks validity of a proposed set of ConfigurationParameters limit and warn parameters are compared if checkLo or checkHi (as relevant) is other than "NONE".

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

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle
postBuild, postInit, postShutdown, postStart, shutdown, start

- 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
```
  - hysteresis
```
protected double hysteresis
```
  - 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
```
  - checkHi
```
protected String checkHi
```
  - alarmHi
```
protected String alarmHi
```
  - pageId
```
protected int pageId
```
  - format
```
protected String format
```
  - doNotTrend
```
protected boolean doNotTrend
```
  - doNotPublish
```
protected boolean doNotPublish
```
  - limitLo
```
@ConfigurationParameter(name="limitLo",
                        category="Limits")
protected volatile double limitLo
```
  - limitHi
```
@ConfigurationParameter(name="limitHi",
                        category="Limits")
protected volatile double limitHi
```
  - warnLo
```
@ConfigurationParameter(name="warnLo",
                        category="Limits")
protected volatile double warnLo
```
  - warnHi
```
@ConfigurationParameter(name="warnHi",
                        category="Limits")
protected volatile double warnHi
```
  - typeI
```
protected int typeI
```
  - alarmLoA
```
protected Alarm alarmLoA
```
  - alarmHiA
```
protected Alarm alarmHiA
```
- Constructor Detail
  - Channel
```
public Channel()
```
- Method Detail
  - build
```
public void build()
```
    Description copied from interface: HasLifecycle
    
    First lifecycle hook. Modification of the component tree is allowed at this stage. After this stage the tree of component cannot be modified anymore. This is where agent periodic tasks should be scheduled.
    
    Specified by:
    
    build in interface HasLifecycle
  - init
```
public void init()
```
    Description copied from interface: HasLifecycle
    
    Called from the enclosing Subsystem at initialization phase.
    This method is called before the children components of this object have their init method called.
    At the time it is called, connection to the messaging layer is not yet done, so there should be no attempt to send messages in the body of this method. Configuration for message listening can nevertheless be done here, such as adding MessageListener objects.
    It is unnecessary to call super.init()
    
    Specified by:
    
    init in interface HasLifecycle
  - validateBulkChange
```
public void validateBulkChange(Map<String,Object> params)
```
    Checks validity of a proposed set of ConfigurationParameters limit and warn parameters are compared if checkLo or checkHi (as relevant) is other than "NONE".
    
    Specified by:
    
    validateBulkChange in interface ConfigurationBulkChangeHandler
    
    Parameters:
    
    Map - of ConfigurationParameters from name to value
  - setParameterBulk
```
public void setParameterBulk(Map<String,Object> params)
```
    Set configuration parameters to new values and compute (derived) quantities (for hysteresis, etc.)
    
    Specified by:
    
    setParameterBulk in interface ConfigurationBulkChangeHandler
    
    Parameters:
    
    Map - of parameters for which a change is requested, keyed by names
  - convertRawValue
```
public double convertRawValue(double rawValue)
```
    Convert a raw value by applying this Channel's offset and scale factors.
    
    Parameters:
    
    rawValue - The raw value to be converted.
    
    Returns:
    
    The converted value: the raw value is multiplied by the scale factor and an offset is added to it.
  - getDevice
```
public final Device getDevice()
```
    Gets the Device associated with this Channel
    
    Returns:
    
    the Device
  - 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
  - getLimitHi
```
public double getLimitHi()
```
    Gets the channel high limit.
    
    Returns:
    
    The channel high limit
  - getWarnLo
```
public double getWarnLo()
```
    Gets the channel low warning level
    
    Returns:
    
    The channel dead warnLo
  - getWarnHi
```
public double getWarnHi()
```
    Gets the channel high warning level
    
    Returns:
    
    The channel warnHi
  - getId
```
public int getId()
```
    Gets the channel ID.
    
    Returns:
    
    The channel ID
  - getHwChan
```
public int getHwChan()
```
    Gets the Hardware Channel
    
    Returns:
    
    The hardware channel
  - getValue
```
@Command(type=QUERY,
         category=CORE)
public double getValue()
```
    Gets the channel value.
    
    Returns:
    
    The last value set by readSensor() (either read from the channel or Double.NaN).
  - 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()
```
  - getGroup
```
public String getGroup()
```
  - getType
```
public int getType()
```
  - getTypeStr
```
public String getTypeStr()
```
  - getSubType
```
public int getSubType()
```
  - getSubTypeStr
```
public String getSubTypeStr()
```
  - getLastMeasurement
```
public Measurement getLastMeasurement()
```
    Gets the last Measurement: a CCSTimeStamp, double pair
    
    Returns:
    
    The last (timestamp, value) pair set by readSensor(); the value is either read from the channel or Double.NaN.
  - hasHysteresis
```
public boolean hasHysteresis()
```
    Returns whether this channel has hysteresis
    
    Returns:
    
    boolean true if channel has hystgeresis applied
  - getHysteresisLimitLo
```
public double getHysteresisLimitLo()
```
    Gets the channel hysteresis low limit.
    
    Returns:
    
    The channel hysteresis low limit
  - getHysteresisLimitHi
```
public double getHysteresisLimitHi()
```
    Gets the channel hysteresis high limit.
    
    Returns:
    
    The channel hysteresis high limit
  - getHysteresisWarnLo
```
public double getHysteresisWarnLo()
```
    Gets the channel hysteresis low warning level
    
    Returns:
    
    The channel hysteresis low warning level
  - getHysteresisWarnHi
```
public double getHysteresisWarnHi()
```
    Gets the channel hysteresis high warning level
    
    Returns:
    
    The channel hysteresis warnHi
  - getConfigurationParameterDescription
```
public ConfigurationParameterDescription getConfigurationParameterDescription(String parName)
```
    Description copied from interface: HasConfigurationParameterDescription
    
    Get a custom ConfigurationParameterDescription for the specified parameter name.
    
    Specified by:
    
    getConfigurationParameterDescription in interface HasConfigurationParameterDescription
    
    Parameters:
    
    parName - The name of the field annotated with the ConfigurationParameter annotation.
    
    Returns:
    
    A ConfigurationParameterDescription for the provided field name. If not null it will be used to overwrite the parameter description as specified in the ConfigurationParameter annotation.

Class Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

Field Detail

TYPE_UNKNOWN

TYPE_TEMP

TYPE_VOLTS

TYPE_POWER

TYPE_SWITCH

TYPE_SUM

TYPE_DIFF

TYPE_PROD

TYPE_QUOT

description

units

hysteresis

devcName

hwChan

type

subtype

offset

scale

checkLo

alarmLo

checkHi

alarmHi

pageId

format

doNotTrend

doNotPublish

limitLo

limitHi

warnLo

warnHi

typeI

alarmLoA

alarmHiA

Constructor Detail

Channel

Method Detail

build

init

validateBulkChange

setParameterBulk

convertRawValue

getDevice

getDescription

getFormat

getUnits

getPageId

getLimitLo

getLimitHi

getWarnLo

getWarnHi

getId

getHwChan

getValue

readValue

getPath

getName

getGroup

getType

getTypeStr

getSubType

getSubTypeStr

getLastMeasurement

hasHysteresis

getHysteresisLimitLo

getHysteresisLimitHi

getHysteresisWarnLo

getHysteresisWarnHi

getConfigurationParameterDescription