org.lsst.ccs.subsystem.monitor

Class Channel

java.lang.Object

org.lsst.ccs.framework.ConfigurableComponent

org.lsst.ccs.subsystem.monitor.Channel

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable

public class Channel
extends org.lsst.ccs.framework.ConfigurableComponent

Handles a monitoring channel.

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_ERROR
static int	STATE_GOOD
static int	STATE_OFFLINE
static int	STATE_WARNING
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.

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

environment

Constructor Summary

Constructors

Constructor and Description
Channel() Constructor.
Channel(String desc, String unit, String devName, int chan, String type, String subtype, double offs, double scal, String checkLo, double limLo, double deadbandLo, String alarmLo, String checkHi, double limHi, double deadbandHi, String alarmHi) Deprecated.
Channel(String desc, String fmt, String unit, String devName, int chan, String type, String subtype, double offs, double scal, String checkLo, double limLo, double deadbandLo, String alarmLo, String checkHi, double limHi, double deadbandHi, String alarmHi) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	enableAlarm(boolean isLow, boolean enable) Enables or disables an alarm.
int	getState() Gets the channel state.
long	getTimestamp() Gets the channel timestamp.
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	setDevcName(String devName) Sets the name of the Device associated with this Channel.
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 org.lsst.ccs.framework.ConfigurableComponent

getChildren, getEnvironment, setEnvironment

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.Configurable

change, dropSubmittedChanges, getCheckedValueFromConfiguration, getComponentByName, getName, getParent, getParentObject, getSubmittedChanges, getSubsystem, init, isParameterConfigurable, notifyChange, notifyChangeWithoutPreliminaryChecks, postStart, printConfigurableParameters, setBulkParameter, shutdownNow, start, submitChange, submitChanges, validateBulkChange

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

STATE_OFFLINE

public static final int STATE_OFFLINE

See Also:

Constant Field Values

STATE_GOOD

public static final int STATE_GOOD

See Also:

Constant Field Values

STATE_WARNING

public static final int STATE_WARNING

See Also:

Constant Field Values

STATE_ERROR

public static final int STATE_ERROR

See Also:

Constant Field Values

Constructor Detail

Channel

public Channel()

Constructor.

Channel

@Deprecated
public Channel(String desc,
                           String fmt,
                           String unit,
                           String devName,
                           int chan,
                           String type,
                           String subtype,
                           double offs,
                           double scal,
                           String checkLo,
                           double limLo,
                           double deadbandLo,
                           String alarmLo,
                           String checkHi,
                           double limHi,
                           double deadbandHi,
                           String alarmHi)

Deprecated.

Constructor.

Parameters:

desc - The descriptive name of the channel.

fmt - The format string for displaying the value.

unit - The units name for the channel.

devName - The name of the device containing the channel.

chan - The hardware channel number of the channel.

type - The type of the channel.

subtype - The sub-type of the channel.

offs - The offset to be applied to the read value.

scal - The scale factor for the read value.

checkLo - The type of check against the low limit.

limLo - The low limit value.

deadbandLo - The low limit deadband value.

alarmLo - The name of the alarm for the low limit.

checkHi - The type of check against the high limit.

limHi - The high limit value.

deadbandHi - The high limit deadband value.

alarmHi - The name of the alarm for the high limit.

Channel

@Deprecated
public Channel(String desc,
                           String unit,
                           String devName,
                           int chan,
                           String type,
                           String subtype,
                           double offs,
                           double scal,
                           String checkLo,
                           double limLo,
                           double deadbandLo,
                           String alarmLo,
                           String checkHi,
                           double limHi,
                           double deadbandHi,
                           String alarmHi)

Deprecated.

Constructor. This is the old version, which doesn't set the format string.

Parameters:

desc - The descriptive name of the channel.

unit - The units name for the channel.

devName - The name of the device containing the channel.

chan - The hardware channel number of the channel.

type - The type of the channel.

subtype - The sub-type of the channel.

offs - The offset to be applied to the read value.

scal - The scale factor for the read value.

checkLo - The type of check against the low limit.

limLo - The low limit value.

deadbandLo - The low limit deadband value.

alarmLo - The name of the alarm for the low limit.

checkHi - The type of check against the high limit.

limHi - The high limit value.

deadbandHi - The high limit deadband value.

alarmHi - The name of the alarm for the high limit.

Method Detail

setFormat

public final void setFormat(String fmt)

Sets the format string for this Channel.

Parameters:

fmt - The provided format to be set

setDevcName

public final void setDevcName(String devName)

Sets the name of the Device associated with this Channel.

Parameters:

devName - The name of the Device as defined in the groovy description node.

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

public void setDbandLo(double value)

Sets the low warning offset (formerly deadband)

Parameters:

value - The value to set

setDbandHi

public void setDbandHi(double value)

Sets the high warning offset (formerly deadband)

Parameters:

value - The value to set

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

public double getValue()

Gets the channel value.

Returns:

The last value successfully read from the channel.

getTimestamp

public long getTimestamp()

Gets the channel timestamp.

Returns:

The timestamp of the last successful read.

getState

public int getState()

Gets the channel state.

Returns:

The channel state.

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