rovsoft::messages::Message Class Reference

The base class for all messages being used for communicaton in rovsoft. More...

#include <Message.hh>

Inheritance diagram for rovsoft::messages::Message:

[legend]Collaboration diagram for rovsoft::messages::Message:

[legend]List of all members.

Public Member Functions
	Message (unsigned short sa, unsigned short da)
	Constructs a new empty message.
virtual void	write (io::OStreamer &out) const throw (io::IOExceptionPtr)
	Writes this message to a stream.
unsigned short	getSource () const
	Get the source of this message.
unsigned short	getDestination () const
	Get the destination of this message.
virtual int	getSize () const
	Returns the size of the message = the number of bytes that would be written by write.
Protected Attributes
unsigned short	source
	The source and the destination of this message.
unsigned short	destination
	The source and the destination of this message.

---

Detailed Description

The base class for all messages being used for communicaton in rovsoft.

---

Constructor & Destructor Documentation

rovsoft::messages::Message::Message (  unsigned short  sa, unsigned short  da )  [inline]

Constructs a new empty message. Parameters: sa  The sender of this message. da  The receiver of this message.

---

Member Function Documentation

unsigned short rovsoft::messages::Message::getDestination (   )  const [inline]

Get the destination of this message.

int rovsoft::messages::Message::getSize (   )  const [virtual]

Returns the size of the message = the number of bytes that would be written by write. (SA and DA are not included!) Reimplemented in rovsoft::messages::ByteTypeMessage, rovsoft::messages::FloatFloatTypeMessage, rovsoft::messages::NByteTypeMessage, rovsoft::messages::NShortTypeMessage, rovsoft::messages::NUByteTypeMessage, rovsoft::messages::ShortTypeMessage, rovsoft::messages::TimeStampedMessage, rovsoft::messages::TsFloatTypeMessage, rovsoft::messages::TsUByteTypeMessage, rovsoft::messages::UByteTypeMessage, rovsoft::messages::ULongTypeMessage, and rovsoft::messages::UShortTypeMessage.

unsigned short rovsoft::messages::Message::getSource (   )  const [inline]

Get the source of this message.

void rovsoft::messages::Message::write (  io::OStreamer &  out  )  const throw (io::IOExceptionPtr) [virtual]

Writes this message to a stream. SA and DA are not written!! Implements rovsoft::lib::Streamable. Reimplemented in rovsoft::messages::ByteTypeMessage, rovsoft::messages::FloatFloatTypeMessage, rovsoft::messages::NByteTypeMessage, rovsoft::messages::NShortTypeMessage, rovsoft::messages::NUByteTypeMessage, rovsoft::messages::ShortTypeMessage, rovsoft::messages::TimeStampedMessage, rovsoft::messages::TsFloatTypeMessage, rovsoft::messages::TsUByteTypeMessage, rovsoft::messages::UByteTypeMessage, rovsoft::messages::ULongTypeMessage, and rovsoft::messages::UShortTypeMessage.

---

Member Data Documentation

unsigned short rovsoft::messages::Message::destination [protected]

The source and the destination of this message.

unsigned short rovsoft::messages::Message::source [protected]

The source and the destination of this message.

---

The documentation for this class was generated from the following files:

• Message.hh
• Message.cc

---