Error Class Reference

Base message for errors. More...

#include <error.h>

Inheritance diagram for Error:

List of all members.

Public Member Functions
	Error (const int iErrorID=-1)
	Constructor.
	Error (const int iErrorID, const std::string &sDescription)
	Constructor.
	~Error ()
	Destructor.
void	setErrorID (const int iErrorID)
	Sets the error ID.
int	getErrorId () const
	Returns the error ID.
void	setDescription (const std::string &sDescription)
	Sets the error ID.
std::string	getDescription () const
	Returns the error description.
virtual void	toXML (XMLWriter &writer) const
	Writes a XML object representation.
virtual void	processMessage () const
	Processes the error.
virtual std::string	toString () const
	Returns a string representation of the answer.
virtual Error &	copy () const
	Returns a copy of this message.
virtual void	toXMLExt (XMLWriter &writer) const
	Writes a XML object representation.
Static Public Attributes
static const char *	ROOT_NODE = "error"
	Error root node.
static const char *	ID_ATTR = "id"
	Name of ID attribute.
static const char *	DESCRIPTION_NODE = "description"
	Name of description node.
static const int	SAXERROR = 1
	SAX Error ID.
static const int	CRYPTEDERROR = 2
	Crypted message not handled error id.

---

Detailed Description

Base message for errors.

The XM representation is :

<ROOT_NODE id_attr="m_iErrorID">
   <DESCRIPTION_NODE>m_sDescription</DESCRIPTION_NODE>
</ROOT_NODE>

Author:

Sylvain Archenault <sylvain.archenault@laposte.net>

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

---

Constructor & Destructor Documentation

Error::Error (  const int  iErrorID = -1  )

Constructor. Parameters: iErrorID  Error ID.

Error::Error (  const int  iErrorID, const std::string &  sDescription )

Constructor. Parameters: iErrorID  Error ID. sDescription  Error short description.

---

Member Function Documentation

Error & Error::copy (   )  const [virtual]

Returns a copy of this message. Returns: Copy of the message. Implements BaseMessage. Reimplemented in CryptedMessageError.

std::string Error::getDescription (   )  const [inline]

Returns the error description. Returns: Error description.

int Error::getErrorId (   )  const [inline]

Returns the error ID. Returns: Error ID.

void Error::setDescription (  const std::string &  sDescription  )  [inline]

Sets the error ID. Parameters: sDescription  Error short description.

void Error::setErrorID (  const int  iErrorID  )  [inline]

Sets the error ID. Parameters: iErrorID  Error ID.

std::string Error::toString (   )  const [virtual]

Returns a string representation of the answer. Returns: String representation. Implements BaseMessage. Reimplemented in CryptedMessageError.

void Error::toXML (  XMLWriter &  writer  )  const [virtual]

Writes a XML object representation. Parameters: writer  XMLWriter object used to write XML representation. Implements BaseMessage.

void Error::toXMLExt (  XMLWriter &  writer  )  const [virtual]

Writes a XML object representation. Parameters: writer  XMLWriter object used to write XML representation. Reimplemented in CryptedMessageError.

---

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

• GM/GM4/Projets/messenger/QtClient/src/Message/error.h
• GM/GM4/Projets/messenger/QtClient/src/Message/error.cpp

---