POErrorMsg Class Reference

A simple text message. More...

#include <POErrorMsg.h>

Inheritance diagram for POErrorMsg:

List of all members.

Public Member Functions
	POErrorMsg (const string &txt="")
	Default constructor.
	POErrorMsg (const char *format,...)
	POErrorMsg (const POErrorMsg &cpy)
virtual	~POErrorMsg ()
virtual string	messageType () const
string	getText () const
void	setText (const string &txt)
virtual POMessage *	clone () const
int	packsize () const
int	pack (char *buf) const
int	unpack (char *buf)

---

Detailed Description

A simple text message.

---

Constructor & Destructor Documentation

POErrorMsg::POErrorMsg (  const string &  txt = ""  )

Default constructor.

POErrorMsg::POErrorMsg (  const char *  format, ...  )

POErrorMsg::POErrorMsg (  const POErrorMsg &  cpy  )

POErrorMsg::~POErrorMsg (   )  [virtual]

---

Member Function Documentation

POMessage * POErrorMsg::clone (   )  const [virtual]

Creates an identical copy of this message. This function must be overloaded in derived classes. Returns: a copy of this message Reimplemented from POMessage.

string POErrorMsg::getText (   )  const [inline]

virtual string POErrorMsg::messageType (   )  const [inline, virtual]

Reimplemented from POMessage.

int POErrorMsg::pack (  char *  buffer  )  const

packs the message into a pre-alocated buffer of size >= packsize() Parameters: buffer  - the buffer to pack into Returns: the number of bytes packed Reimplemented from POMessage.

int POErrorMsg::packsize (   )  const

calculates the number of bytes needed to pack this message Returns: size in bytes Reimplemented from POMessage.

void POErrorMsg::setText (  const string &  txt  )

int POErrorMsg::unpack (  char *  buffer  )

unpacks the message, setting source, destination, and derived type Parameters: buffer  the buffer to unpack, must be valid, no error checking Returns: the number of bytes unpacked Reimplemented from POMessage.

---

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

• POErrorMsg.h
• POErrorMsg.cpp

---