zeus::TTextMessage Class Reference

#include <TextMessage.h>

Inheritance diagram for zeus::TTextMessage:

List of all members.

Public Member Functions
	TTextMessage ()
	TTextMessage (const IString &rText)
virtual void MQUALIFIER	getText (IString &rText) const
virtual void MQUALIFIER	setText (const IString &rText)
virtual void MQUALIFIER	clearBody ()
virtual void MQUALIFIER	clearProperties ()
virtual void MQUALIFIER	getInterfaceID (InterfaceID &rIID) const
virtual Uint MQUALIFIER	getMessageID () const
virtual Uint MQUALIFIER	getPriority () const
virtual void MQUALIFIER	getSender (TypGUID &rValue) const
virtual void MQUALIFIER	getRecipients (IList< TypGUID > &rlstValue) const
virtual Retval MQUALIFIER	getPropertyValue (const IString &rName, IString &rValue) const
virtual Uint64 MQUALIFIER	getTimeStamp () const
virtual void MQUALIFIER	setMessageID (Uint uiValue)
virtual void MQUALIFIER	setPropertyValue (const IString &rName, const IString &rValue)
virtual void MQUALIFIER	setPriority (Uint uiValue)
virtual void MQUALIFIER	setSender (const TypGUID &rValue)
virtual void MQUALIFIER	setRecipient (const TypGUID &rValue)
virtual void MQUALIFIER	setRecipients (const IList< TypGUID > &rlstValue)
virtual void MQUALIFIER	setTimeStamp (const Uint64 &rui64Value)
	SERIAL_PARENTCLASS (TAbstractMessage) SERIAL_STRING(m_strText) virtual Retval MQUALIFIER askForInterface(const InterfaceID &rInterfaceID
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
Public Attributes
IZUnknown *&	rpIface
Protected Member Functions
virtual	~TTextMessage ()

---

Detailed Description

This class implements a system message. Those messages are used for controlling and status reports. The format is binary.

---

Constructor & Destructor Documentation

zeus::TTextMessage::TTextMessage

(

)

TTextMessage::TTextMessage

(

const IString &

rText )

Creates a new text message object out of a text string

Parameters:

rText

: Text string

TTextMessage::~TTextMessage

(

)

[protected, virtual]

Destroys the message object

---

Member Function Documentation

virtual void MQUALIFIER zeus::TTextMessage::addRef

(

)

const [virtual]

See also:

IZUnknown::addRef

Reimplemented from zeus::TAbstractMessage.

void MQUALIFIER TTextMessage::clearBody

(

)

[virtual]

See also:

IMessage::clearBody

Implements zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::clearProperties

(

)

[inline, virtual]

See also:

IMessage::clearProperties

Reimplemented from zeus::TAbstractMessage.

void MQUALIFIER zeus::TTextMessage::getInterfaceID

(

InterfaceID &

rIID )

const [inline, virtual]

See also:

IMessage::getInterfaceID

Implements zeus::TAbstractMessage.

virtual Uint MQUALIFIER zeus::TTextMessage::getMessageID

(

)

const [inline, virtual]

See also:

IMessage::getMessageID

Reimplemented from zeus::TAbstractMessage.

virtual Uint MQUALIFIER zeus::TTextMessage::getPriority

(

)

const [inline, virtual]

See also:

IMessage::getPriority

Reimplemented from zeus::TAbstractMessage.

virtual Retval MQUALIFIER zeus::TTextMessage::getPropertyValue	(	const IString &	rName,
		IString &	rValue
	)		const [inline, virtual]

See also:

IMessage::getPropertyValue

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::getRecipients

(

IList< TypGUID > &

rlstValue )

const [inline, virtual]

See also:

IMessage::getRecipients

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::getSender

(

TypGUID &

rValue )

const [inline, virtual]

See also:

IMessage::getSender

Reimplemented from zeus::TAbstractMessage.

void MQUALIFIER TTextMessage::getText

(

IString &

rText )

const [virtual]

See also:

ITextMessage::getText

Implements zeus::ITextMessage.

virtual Uint64 MQUALIFIER zeus::TTextMessage::getTimeStamp

(

)

const [inline, virtual]

See also:

IMessage::getTimestamp

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::release

(

)

const [virtual]

See also:

IZUnknown::release

Reimplemented from zeus::TAbstractMessage.

zeus::TTextMessage::SERIAL_PARENTCLASS

(

TAbstractMessage

)

const

virtual void MQUALIFIER zeus::TTextMessage::setMessageID

(

Uint

uiValue )

[inline, virtual]

See also:

IMessage::setMessageID

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::setPriority

(

Uint

uiValue )

[inline, virtual]

See also:

IMessage::setPriority

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::setPropertyValue	(	const IString &	rName,
		const IString &	rValue
	)		[inline, virtual]

See also:

IMessage::setPropertyValue

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::setRecipient

(

const TypGUID &

rValue )

[inline, virtual]

See also:

IMessage::setRecipient

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::setRecipients

(

const IList< TypGUID > &

rlstValue )

[inline, virtual]

See also:

IMessage::setRecipients

Reimplemented from zeus::TAbstractMessage.

virtual void MQUALIFIER zeus::TTextMessage::setSender

(

const TypGUID &

rValue )

[inline, virtual]

See also:

IMessage::setSender

Reimplemented from zeus::TAbstractMessage.

void MQUALIFIER TTextMessage::setText

(

const IString &

rText )

[virtual]

See also:

ITextMessage::setText

Implements zeus::ITextMessage.

virtual void MQUALIFIER zeus::TTextMessage::setTimeStamp

(

const Uint64 &

rui64Value )

[inline, virtual]

See also:

IMessage::setTimestamp

Reimplemented from zeus::TAbstractMessage.

---

Member Data Documentation

IZUnknown*& zeus::TTextMessage::rpIface

Reimplemented from zeus::TAbstractMessage.

---

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

• TextMessage.h
• TextMessage.cpp