BambooMessage Class Reference

This object store the content of a message used in bamboo messenger. More...

#include <bamboomessage.h>

Inheritance diagram for BambooMessage:

BaseMessage List of all members.

Public Member Functions

 BambooMessage (MessageHeader *pHeader=0, BaseMessage *pContent=0)
 Constructor.
 BambooMessage (const BambooMessage &bambooMsg)
 Copy constructor.
BambooMessageoperator= (const BambooMessage bambooMsg)
 Assignment operator.
void swap (const BambooMessage &bambooMsg)
 Exchange *this's and rhs's data.
 ~BambooMessage ()
 Destructor.
void setHeader (const MessageHeader *pHeader)
 Sets the header of the BambooMessage object.
void setContent (const BaseMessage *pContent)
 Sets the content of the BambooMesage object.
const BaseMessagegetContent () const
 Returns BambooMessage content.
const MessageHeadergetHeader () const
 Returns BambooMessage Header.
void toXML (XMLWriter &writer) const
 Writes an XML serialization of this object using writer object.
void processMessage () const
 Executes some instructions in order to process this message.
std::string toString () const
 Returns a String representation of Bamboo Message.
BambooMessagecopy () const
 Returns a copy of this message.

Protected Attributes

const BaseMessagem_pContent
 BambooMessage content.
const MessageHeaderm_pHeader
 BambooMessage header.

Detailed Description

This object store the content of a message used in bamboo messenger.

In one message, we have a require part, the header, and then an optional part, i.e, content, request or answer..

Author:
Sylvain Archenault <sylvain.archenault@laposte.net>

Yves Houpert <yves.houpert@insa-rouen.fr>


Constructor & Destructor Documentation

BambooMessage::BambooMessage MessageHeader pHeader = 0,
BaseMessage pContent = 0
 

Constructor.

Parameters:
pHeader BambooMessage Header, could be null.
pContent BambooMessage Content, could be null.

BambooMessage::BambooMessage const BambooMessage bambooMsg  ) 
 

Copy constructor.

Parameters:
bambooMsg Bamboo Message to construct;


Member Function Documentation

BambooMessage & BambooMessage::copy  )  const [virtual]
 

Returns a copy of this message.

Returns:
Copy of the message.

Implements BaseMessage.

const BaseMessage* BambooMessage::getContent  )  const [inline]
 

Returns BambooMessage content.

Returns:
BambooMessage content.

const MessageHeader* BambooMessage::getHeader  )  const [inline]
 

Returns BambooMessage Header.

Returns:
BambooMessage Header.

BambooMessage & BambooMessage::operator= const BambooMessage  bambooMsg  ) 
 

Assignment operator.

Returns:
Reference to tho this object.

void BambooMessage::setContent const BaseMessage pContent  ) 
 

Sets the content of the BambooMesage object.

Parameters:
pContent Pointer to the BaseMessage content.

void BambooMessage::setHeader const MessageHeader pHeader  ) 
 

Sets the header of the BambooMessage object.

Parameters:
pHeader Pointer to the MessageHeader.

void BambooMessage::swap const BambooMessage bambooMsg  ) 
 

Exchange *this's and rhs's data.

Parameters:
bambooMsg BambooMessage to swap with.

std::string BambooMessage::toString  )  const [virtual]
 

Returns a String representation of Bamboo Message.

Returns:
BambooMesasge string representation.

Implements BaseMessage.

void BambooMessage::toXML XMLWriter writer  )  const [virtual]
 

Writes an XML serialization of this object using writer object.

See also:
BaseMessage::toXML( XMLWriter& writer )

Implements BaseMessage.


The documentation for this class was generated from the following files:
Generated on Fri May 19 12:15:55 2006 for Bamboo Ch@t by  doxygen 1.4.6