org.lsst.ccs.bus.messages

Class BusMessage

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CommandMessage, LogMessage, StatusMessage

public abstract class BusMessage
extends Object
implements Serializable

Base class for messages sent on the buses. Concrete implementations (command, status and log messages) will be sent on the appropriate bus. NOTE: Can we remove some or all the setter methods? NOTE: This is currently an interface and it will replace the implementation of org.lsst.ccs.bus.BusMessage

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BusMessage()

Method Summary

Modifier and Type	Method and Description
AgentInfo	getOriginAgentInfo() The Origin of the BusMessage, the bus registration name of the Agent from which it originated.
String	getSummary() The summary string for this BusMessage.
long	getTimeStamp() Get the timestamp associated to this BusMessage.
void	setOriginAgentInfo(AgentInfo agent) Sets the origin for this BusMessage.
void	setSummary(String summary) Set the summary for this BusMessage.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusMessage

public BusMessage()

Method Detail

getOriginAgentInfo

public AgentInfo getOriginAgentInfo()

The Origin of the BusMessage, the bus registration name of the Agent from which it originated.

Returns:

The origin of this BusMessage.

setOriginAgentInfo

public final void setOriginAgentInfo(AgentInfo agent)

Sets the origin for this BusMessage. This method should only be used internally, by the MessagingLayer Architecture. It must not be used by users/developers.

Parameters:

agent - The origin of the BusMessage.

getTimeStamp

public long getTimeStamp()

Get the timestamp associated to this BusMessage. This is in milliseconds since 1970. Is this the time when the message was sent or created? Right now it's created.

Returns:

The BusMessage timestamp.

getSummary

public String getSummary()

The summary string for this BusMessage. This is currently used only for Alarms. Could this be used by BusMessage listeners to display summary information about received BusMessages?

Returns:

The summary string for this BusMessage

setSummary

public void setSummary(String summary)

Set the summary for this BusMessage. Who should use this method?

Parameters:

summary - The summary for this BusMessage.