regcom::network::Message

Message Class Reference

#include <Message.h>

List of all members.


Public Member Functions

 Message ()
 Public constructor.
virtual ~Message ()
 Virtal destructor.
common::ErrorCodeType GetValue (std::string &rValue) const
 Gets message value.
common::ErrorCodeType SetValue (const std::string &rValue)
 Sets message value.
common::ErrorCodeType GetAttribute (const std::string &rAttribute, std::string &rValue) const
 Gets attribute value.
common::ErrorCodeType SetAttribute (const std::string &rAttribute, const std::string &rValue)
 Sets attribute value.
common::ErrorCodeType SetAttribute (const std::string &rAttribute, int value)
 Sets attribute value.

Private Attributes

MessageData * m_pMessageData
 Pointer to private message data.

Friends

std::istream & operator>> (std::istream &rInputStream, Message &rMessage)
std::ostream & operator<< (std::ostream &rOutputStream, const Message &rMessage)

Detailed Description

Message class.
Full Description
This class provides message functionality.

Constructor & Destructor Documentation

Message (  ) 

Public constructor.

Full Description
This method creates a new instance of the class.
Returns:
New instance of the class.

~Message (  )  [virtual]

Virtal destructor.

Full Description
This method destroys an existing instance of the class.
Returns:
None.

Member Function Documentation

common::ErrorCodeType GetValue ( std::string &  rValue  )  const

Gets message value.

Full Description
This method gets the message value.
Returns:
Success if successful.

Failure otherwise.

common::ErrorCodeType SetValue ( const std::string &  rValue  ) 

Sets message value.

Full Description
This method sets the message value.
Returns:
Success if successful.

Failure otherwise.

common::ErrorCodeType GetAttribute ( const std::string &  rAttribute,
std::string &  rValue 
) const

Gets attribute value.

Full Description
This method gets an attribute value.
Returns:
Success if successful.

Failure otherwise.

common::ErrorCodeType SetAttribute ( const std::string &  rAttribute,
const std::string &  rValue 
)

Sets attribute value.

Full Description
This method sets an attribute value.
Returns:
Success if successful.

Failure otherwise.

common::ErrorCodeType SetAttribute ( const std::string &  rAttribute,
int  value 
)

Sets attribute value.

Full Description
This method sets an attribute value.
Returns:
Success if successful.

Failure otherwise.

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  rInputStream,
Message &  rMessage 
) [friend]

Full Description
This operator gets the message from an input stream.
Returns:
Input stream.
Parameters:
rInputStream  Input stream.
rMessage  Message.

std::ostream& operator<< ( std::ostream &  rOutputStream,
const Message &  rMessage 
) [friend]

Full Description
This operator puts the message into an ouput stream.
Returns:
Output stream.
Parameters:
rOutputStream  Output stream.
rMessage  Message.

Member Data Documentation

MessageData* m_pMessageData [private]

Pointer to private message data.

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