---

IDEA::MessageHandle Class Reference
[Agent handle classes]

This class is handle to a Message instance. More...

#include <MessageHandle.hh>

List of all members.

Public Methods
	MessageHandle ()
	Creates an empty handle.
	MessageHandle (Message *message)
	Creates a handle instance to message.
	MessageHandle (const MessageHandle &msg)
	Creates a handle to the same instance as msg.
const MessageHandle &	operator= (const MessageHandle &other)
	Sets the implementation of the invoking handle to the same implementation as other.
const MessageData *	getData () const
	Returns a pointer to the data of the invoking message. Be aware that the pointer to the MessageData has the same lifecycle as the implementation of the Message instance the invoking handle points to. You can always clone the data by invoking MessageData::clone.
const Time &	getTime () const
	Returns the time when this messages has been received or when it was created to be send out.
const Message::Type &	getType () const
	Returns the type of the invoking message.
Message *	getImplementation () const
	Reurns the implemenation of the message instanct of the invoking handle.
MessageHandle	clone () const
	Returns a handle with a clone(!) of the instance of the invoking handle.
void	release ()
	Releases the memory used to store the implementation.
Private Attributes
Message *	m_Implementation

---

Detailed Description

This class is handle to a Message instance.

Author:

David Rijsman rijsman@email.arc.nasa.gov

---

Constructor & Destructor Documentation

IDEA::MessageHandle::MessageHandle (    )

Creates an empty handle. Constructor

IDEA::MessageHandle::MessageHandle (  Message *    message )  [inline]

Creates a handle instance to message. Constructor

IDEA::MessageHandle::MessageHandle (  const MessageHandle &    msg )  [inline]

Creates a handle to the same instance as msg. Constructor

---

Member Function Documentation

MessageHandle IDEA::MessageHandle::clone (    )  const [inline]

Returns a handle with a clone(!) of the instance of the invoking handle.

const MessageData* IDEA::MessageHandle::getData (    )  const [inline]

Returns a pointer to the data of the invoking message. Be aware that the pointer to the MessageData has the same lifecycle as the implementation of the Message instance the invoking handle points to. You can always clone the data by invoking MessageData::clone.

Message* IDEA::MessageHandle::getImplementation (    )  const [inline]

Reurns the implemenation of the message instanct of the invoking handle.

const Time& IDEA::MessageHandle::getTime (    )  const [inline]

Returns the time when this messages has been received or when it was created to be send out.

const Message::Type& IDEA::MessageHandle::getType (    )  const [inline]

Returns the type of the invoking message.

const MessageHandle& IDEA::MessageHandle::operator= (  const MessageHandle &    other )  [inline]

Sets the implementation of the invoking handle to the same implementation as other. Assignment operator

void IDEA::MessageHandle::release (    )  [inline]

Releases the memory used to store the implementation. The implementation of the handle is 0 after calling this method.

---

Member Data Documentation

Message* IDEA::MessageHandle::m_Implementation [private]

Implementation of the message

---

Contact information © IDEA