org.lsst.ccs.gconsole.plugins.monitor

Class MonitorCell

java.lang.Object

org.lsst.ccs.gconsole.plugins.monitor.MonitorCell

public class MonitorCell
extends Object

Data model for a graphical component that displays a single monitored value. There is a single MonitorField instance associated with this model, describing the type of the displayed value, and a list of contributing ChannelHandle objects. The model also contains the current FormattedValue.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static MonitorCell	EMPTY

Constructor Summary

Constructors

Constructor and Description
MonitorCell() Constructs a cell with no associated channels, NULL field, and no formatted current value.
MonitorCell(ChannelHandle item, MonitorField field) Constructs a cell affected by a single data channel, with no current formatted value.
MonitorCell(List<? extends ChannelHandle> items, MonitorField field) Constructs a cell affected by zero or more data channels, with no current formatted value.
MonitorCell(List<? extends ChannelHandle> items, MonitorField field, FormattedValue data) Constructs a cell affected by zero or more data channels, with no current formatted value.

Method Summary

Modifier and Type	Method and Description
List<ChannelHandle>	getChannels() Returns the list of handles for data channels that affect this cell.
MonitorField	getField() Returns the descriptor of the monitored field this cell displays.
FormattedValue	getFormattedValue() Returns the current formatted value to be displayed by this cell.
void	setFormattedValue(FormattedValue formattedValue) Sets the current formatted value to be displayed by this cell.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY

public static MonitorCell EMPTY

Constructor Detail

MonitorCell

public MonitorCell()

Constructs a cell with no associated channels, NULL field, and no formatted current value.

MonitorCell

public MonitorCell(ChannelHandle item,
                   MonitorField field)

Constructs a cell affected by a single data channel, with no current formatted value.

Parameters:

item - Handle of the channel to be displayed, or null if cell is unaffected by any channels.

field - Field to be displayed.

MonitorCell

public MonitorCell(List<? extends ChannelHandle> items,
                   MonitorField field)

Constructs a cell affected by zero or more data channels, with no current formatted value.

Parameters:

items - Handles of the channels contributing to this cell. The list will be owned by this cell.

field - Field to be displayed.

MonitorCell

public MonitorCell(List<? extends ChannelHandle> items,
                   MonitorField field,
                   FormattedValue data)

Constructs a cell affected by zero or more data channels, with no current formatted value.

Parameters:

items - Handles of the channels contributing to this cell. The list will be owned by this cell.

field - Field to be displayed.

Method Detail

getChannels

public List<ChannelHandle> getChannels()

Returns the list of handles for data channels that affect this cell.

Returns:

List of contributing channels.

getField

public MonitorField getField()

Returns the descriptor of the monitored field this cell displays.

Returns:

Field descriptor.

setFormattedValue

public void setFormattedValue(FormattedValue formattedValue)

Sets the current formatted value to be displayed by this cell.

Parameters:

formattedValue - New formatted value.

getFormattedValue

public FormattedValue getFormattedValue()

Returns the current formatted value to be displayed by this cell.

Returns:

Current formatted value.