---

IDEA::Message Class Reference
[Agent handle classes]

This class is the base class for all messages. More...

#include <Message.hh>

Inheritance diagram for IDEA::Message:

List of all members.

Public Types
typedef std::list< Message * >	MessageList
enum	Type {   UNDEFINED = 0, START = 2, STOP = 4, VALUE = 8,   STATUS = 16, TELEMETRY = 32, OBJECT = 64, USERDEFINED = 128 }
Public Methods
	Message (const Time &time, const MessageData *data)
	Message (const Time &time, const MessageData &data)
virtual	~Message ()
	Destructor.
virtual Message *	clone () const
	Should return a clone of the invoking message with deep copy.
Protected Methods
MessageData *	getData () const
const Time &	getTime () const
	Returns the time of the invoking message.
const Message::Type &	getType () const
	Returns the 'type' of the message.
Private Methods
	Message ()
	Default constructor, not implemented by design.
	Message (const Message &)
	Copy constructor, not implemented by design.
const Message &	operator= (const Message &other)
	Assignment operator, not implemented by design.
Private Attributes
Time	m_Time
MessageData *	m_Data
Friends
class	MessageHandle

---

Detailed Description

This class is the base class for all messages.

Author:

David Rijsman rijsman@email.arc.nasa.gov

The base class contains information on the type of the message and when the message was received or constructed to be send out.

---

Member Typedef Documentation

typedef std::list< Message*> IDEA::Message::MessageList

---

Member Enumeration Documentation

enum IDEA::Message::Type

Enumeration values: UNDEFINED  START  Message indicating the start of a token, send out to goal timelines to create tokens on them. STOP  Message indicating the stop of a token, send out to goal timelines to stop tokens on them. VALUE  Message indicating the value of a paramter if the token/predicate changed, send out to timelines. STATUS  Message indicating the status of a predicate changed. TELEMETRY  Message send to a timeline updating the status of whatever token is at the timeline at the time of receiving. OBJECT  Message indicating the value of an object. USERDEFINED  Message user-defined.

---

Constructor & Destructor Documentation

IDEA::Message::Message (  const Time &    time, const MessageData *    data )

brief Constructor, will copy data

IDEA::Message::Message (  const Time &    time, const MessageData &    data )

brief Constructor, will copy data

IDEA::Message::~Message (    )  [virtual]

Destructor. Will also delete all sub-messages.

IDEA::Message::Message (    )  [private]

Default constructor, not implemented by design.

IDEA::Message::Message (  const Message &    )  [private]

Copy constructor, not implemented by design.

---

Member Function Documentation

Message * IDEA::Message::clone (    )  [virtual]

Should return a clone of the invoking message with deep copy. Implements IDEA::Prototype.

MessageData* IDEA::Message::getData (    )  const [inline, protected]

const Time& IDEA::Message::getTime (    )  const [inline, protected]

Returns the time of the invoking message. If the message is an incoming message this time is the time of arrival if the message is a outgoing message than this time is the time of construction of the message.

const Message::Type & IDEA::Message::getType (    )  [protected]

Returns the 'type' of the message.

const Message& IDEA::Message::operator= (  const Message &    other )  [private]

Assignment operator, not implemented by design.

---

Friends And Related Function Documentation

friend class MessageHandle [friend]

---

Member Data Documentation

MessageData* IDEA::Message::m_Data [private]

Time IDEA::Message::m_Time [private]

Time the message has been constructed/received

---

Contact information © IDEA