org.lsst.ccs.gconsole.agent

Class AgentChannel

java.lang.Object

org.lsst.ccs.gconsole.agent.AgentChannel

Direct Known Subclasses:

MutableAgentChannel

public class AgentChannel
extends Object

Encapsulates static properties and current status of a data channel. Each channel has a central value (an Object) and optional attributes identified by string keys. A channel is identified by a unique path (slash-separated string, with the subsystem name as the first element). The path is used to establish channel equality and hash code.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,Object>	data
static AgentChannel	NONE Immutable empty channel.
protected Object	value
static String	VALUE_KEY Key that identifies the central value of a channel.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AgentChannel(AgentChannel other) Copy constructor.
protected	AgentChannel(String path, org.lsst.ccs.bus.data.AgentInfo agent) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get() Returns the current central value of this channel.
Object	get(String key) Returns the value of the channel attribute identified by the key.
org.lsst.ccs.bus.data.AgentInfo	getAgent() Returns the descriptor of the Agent this channel belongs to.
String	getAgentName() Returns the name of the Agent this channel belongs to.
String	getLocalPath() Returns the path of this channel with the agent name and the following slash stripped.
String	getPath() Return the unique path of this channel.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static AgentChannel NONE

Immutable empty channel.

VALUE_KEY

public static final String VALUE_KEY

Key that identifies the central value of a channel. Allows treating the central value as an attribute whenever string keys are used to identify channel attributes.

See Also:

Constant Field Values

value

protected Object value

data

protected HashMap<String,Object> data

Constructor Detail

AgentChannel

protected AgentChannel(String path,
                       org.lsst.ccs.bus.data.AgentInfo agent)

Constructs an instance.

Parameters:

path - Unique path identifying this channel.

agent - Agent this channel belongs to.

AgentChannel

public AgentChannel(AgentChannel other)

Copy constructor.

Parameters:

other - Channel to copy.

Method Detail

getPath

public String getPath()

Return the unique path of this channel.

Returns:

Channel path in (agent name)/(local path) form.

getAgentName

public String getAgentName()

Returns the name of the Agent this channel belongs to.

Returns:

Agent name.

getAgent

public org.lsst.ccs.bus.data.AgentInfo getAgent()

Returns the descriptor of the Agent this channel belongs to.

Returns:

Agent descriptor.

getLocalPath

public String getLocalPath()

Returns the path of this channel with the agent name and the following slash stripped. Local paths are unique inside an agent.

Returns:

Local path.

get

public Object get(String key)

Returns the value of the channel attribute identified by the key.

Parameters:

key - Attribute key. If VALUE_KEY, the central value is returned.

Returns:

Attribute value, or null if this channel does not have the specified attribute.

get

public Object get()

Returns the current central value of this channel.

Returns:

Current value.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object