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

Inherits edu.cmu.hcii.calo.messagePassing.Message.

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

A type of Message that pertains to the modification and management of relevant resources in the RelevantInfoManager.

Author:
Brian Ellis


Public Types

enum  RelevantResourceMessageType
 The possible types of a RelevantResourceMessage. More...

Public Member Functions

 RelevantResourceMessage (RelevantInfoManager manager, RelevantResourceMessageType type, ResourceList r)
 Constructs a RelevantResourceMessage for the given manager, message type, and resource list.
 RelevantResourceMessage (RelevantInfoManager manager, RelevantResourceMessageType type, ResourceList r, Map< String, Object > userInfo)
 Constructs a RelevantResourceMessage for the given manager, message type, resource list, and user info map.
ResourceList getResources ()
 Accessor method for resources.

Private Member Functions

 RelevantResourceMessage (Observable sender, MessageType type)
 Private constructor.
 RelevantResourceMessage (Observable sender, MessageType type, Map< String, Object > userInfo)
 Private constructor.

Private Attributes

ResourceList resources
 The resources to which this message pertains.

Static Private Attributes

static final long serialVersionUID = -6953136420412472710L
 To prevent serialization collisions.


Member Enumeration Documentation

enum edu::cmu::hcii::calo::messagePassing::RelevantResourceMessage::RelevantResourceMessageType

The possible types of a RelevantResourceMessage.

Currently there is only one of these, because the relevant resource list will typically change wholesale rather than selective elements being added or deleted.

Author:
Brian Ellis


Constructor & Destructor Documentation

edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage.RelevantResourceMessage ( RelevantInfoManager  manager,
RelevantResourceMessageType  type,
ResourceList  r 
)

Constructs a RelevantResourceMessage for the given manager, message type, and resource list.

Parameters:
manager the manager sending the message
r the resource list to which the message pertains
type the type of the message

edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage.RelevantResourceMessage ( RelevantInfoManager  manager,
RelevantResourceMessageType  type,
ResourceList  r,
Map< String, Object >  userInfo 
)

Constructs a RelevantResourceMessage for the given manager, message type, resource list, and user info map.

Parameters:
manager the manager sending the message
r the resource list to which the message pertains
type the type of the message
userInfo the user info map for this message

edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage.RelevantResourceMessage ( Observable  sender,
MessageType  type 
) [private]

Private constructor.

Use RelevantResourceMessage.RelevantResourceMessage(Observable, MessageType, ResourceList) instead.

Parameters:
sender the object that sent this message
type the type of this message

edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage.RelevantResourceMessage ( Observable  sender,
MessageType  type,
Map< String, Object >  userInfo 
) [private]

Private constructor.

Use RelevantResourceMessage.RelevantResourceMessage(Observable, MessageType, ResourceList, Map) instead.

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


Member Function Documentation

ResourceList edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage.getResources (  ) 

Accessor method for resources.

Returns:
the value of resources


Member Data Documentation

final long edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage.serialVersionUID = -6953136420412472710L [static, private]

To prevent serialization collisions.

ResourceList edu.cmu.hcii.calo.messagePassing.RelevantResourceMessage.resources [private]

The resources to which this message pertains.


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