edu.cmu.hcii.calo.messagePassing.Message Class Reference

Inherited by edu.cmu.hcii.calo.messagePassing.HistoryMessage, edu.cmu.hcii.calo.messagePassing.NotificationMessage, edu.cmu.hcii.calo.messagePassing.PackMessage, edu.cmu.hcii.calo.messagePassing.RelevantActionMessage, edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage, edu.cmu.hcii.calo.messagePassing.ScheduleMessage, edu.cmu.hcii.calo.messagePassing.TaskGroupMessage, edu.cmu.hcii.calo.messagePassing.TasklikeObjectMessage, edu.cmu.hcii.calo.messagePassing.TaskMessage, and edu.cmu.hcii.calo.messagePassing.WizardOfOzMessage.

Inheritance diagram for edu.cmu.hcii.calo.messagePassing.Message:

Inheritance graph
[legend]
Collaboration diagram for edu.cmu.hcii.calo.messagePassing.Message:

Collaboration graph
[legend]
List of all members.

Detailed Description

Represents a message passed between various parts of the system.

Messages are sent by Observable instances and passed as the parameter to the Observable.notifyObservers(Object) method.

Author:
Brian Ellis


Public Member Functions

 Message (Observable sender, MessageType type)
 Constructs a new Message with an empty userInfo map.
 Message (Observable sender, MessageType type, Map< String, Object > userInfo)
 Constructs a new Message.
MessageType getMessageType ()
 Accessor method for messageType.
Observable getSender ()
 Accessor method for sender.
Map< String, Object > getUserInfo ()
 Accessor method for userInfo.

Protected Attributes

MessageType messageType
 The type of this message.

Private Attributes

Observable sender
 The object that sent this message.
Map< String, Object > userInfo
 Any message-specific data associated with this message.


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.Message.Message ( Observable  sender,
MessageType  type 
)

Constructs a new Message with an empty userInfo map.

Parameters:
sender the Observable that has sent this message
type the type of this message

edu.cmu.hcii.calo.messagePassing.Message.Message ( Observable  sender,
MessageType  type,
Map< String, Object >  userInfo 
)

Constructs a new Message.

Parameters:
sender the Observable that has sent this message
type the type of this message
userInfo the map of message-specific data associated with this message


Member Function Documentation

MessageType edu.cmu.hcii.calo.messagePassing.Message.getMessageType (  ) 

Accessor method for messageType.

Returns:
the value of messageType

Observable edu.cmu.hcii.calo.messagePassing.Message.getSender (  ) 

Accessor method for sender.

Returns:
the value of sender

Map<String, Object> edu.cmu.hcii.calo.messagePassing.Message.getUserInfo (  ) 

Accessor method for userInfo.

Returns:
the value of userInfo


Member Data Documentation

MessageType edu.cmu.hcii.calo.messagePassing.Message.messageType [protected]

The type of this message.

Observable edu.cmu.hcii.calo.messagePassing.Message.sender [private]

The object that sent this message.

Map<String, Object> edu.cmu.hcii.calo.messagePassing.Message.userInfo [private]

Any message-specific data associated with this message.


The documentation for this class was generated from the following file:
Generated on Mon Aug 13 15:06:15 2007 for CALO by  doxygen 1.5.2