org.lsst.ccs.gconsole.services.aggregator

Class StateChannel

java.lang.Object

org.lsst.ccs.gconsole.services.aggregator.BasicChannel

org.lsst.ccs.gconsole.services.aggregator.StateChannel

All Implemented Interfaces:

AgentChannel

public class StateChannel
extends BasicChannel

AgentChannel to be used for states whose values can be assigned one of the DataProviderState categories. This can be useful for color coding, etc.

Implementation note. Currently, DataProviderState categories are assigned manually in the constructor, only to core states. If we ever want to assign categories to subsystem-specific states, it would make sense to shift those assignments to state enum definitions.

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.gconsole.services.aggregator.AgentChannel

AgentChannel.Key

Field Summary

Fields inherited from class org.lsst.ccs.gconsole.services.aggregator.BasicChannel

data, value

Fields inherited from interface org.lsst.ccs.gconsole.services.aggregator.AgentChannel

MARK_ALERT, MARK_CONFIG, MARK_STATE

Constructor Summary

Constructors

Constructor and Description
StateChannel(String path, org.lsst.ccs.bus.data.AgentInfo agent, Map<String,Object> attributes, Object value) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	set(Object value) Sets the value of this channel.

Methods inherited from class org.lsst.ccs.gconsole.services.aggregator.BasicChannel

equals, get, get, getAgent, getAgentName, getAttributes, getLocalPath, getPath, hashCode, set, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StateChannel

public StateChannel(String path,
                    org.lsst.ccs.bus.data.AgentInfo agent,
                    Map<String,Object> attributes,
                    Object value)

Constructs an instance.

Parameters:

path - Unique path identifying this channel.

agent - Agent this channel belongs to.

attributes - Static attributes and metadata associated with this channel.

value - Current value.

Method Detail

set

public boolean set(Object value)

Description copied from class: BasicChannel

Sets the value of this channel. The value will not change if the new value is equal to the old one.

Specified by:

set in interface AgentChannel

Overrides:

set in class BasicChannel

Parameters:

value - New value.

Returns:

true if the value has changed as a result of this call.