org.lsst.ccs.monitor

Class Channel

java.lang.Object

org.lsst.ccs.monitor.Channel

Direct Known Subclasses:

Channel, Control

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
static int	STATE_ERROR
static int	STATE_GOOD
static int	STATE_OFFLINE
static int	STATE_WARNING
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()

Method Summary

Modifier and Type	Method and Description
void	enableAlarm(boolean isLow, boolean enable) Enables or disables an alarm.
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 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

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

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

protected double dbandLo

checkHi

protected String checkHi

alarmHi

protected String alarmHi

dbandHi

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

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.

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