zorba::UserError Class Reference

A UserError is-a Diagnostic for user-defined errors via fn:error(). More...

#include <zorba/error.h>

Inheritance diagram for zorba::UserError:

Collaboration diagram for zorba::UserError:

List of all members.

Public Member Functions
diagnostic::category	category () const
	Gets the category of this diagnostic.
virtual diagnostic::kind	kind () const
	Gets the kind of this diagnostic.
virtual char const *	message () const
	Gets the message of this diagnostic.
UserError &	operator= (UserError const &from)
	Assigns this UserError from another.
diagnostic::QName const &	qname () const
	Gets the QName for this diagnostic.
	UserError (UserError const &from)
	Copy-constructs a UserError.
	~UserError ()
	Destroys this UserError.
Protected Member Functions
Diagnostic const *	clone () const
virtual void	destroy () const
	Destroys a Diagnostic.
Friends
UserError	make_user_error (char const *, char const *, char const *)
void	serialization::operator& (serialization::Archiver &, const Diagnostic *&)
class	UserException
class	ZorbaException

---

Detailed Description

A UserError is-a Diagnostic for user-defined errors via fn:error().

Definition at line 50 of file error.h.

---

Constructor & Destructor Documentation

zorba::UserError::UserError

(

UserError const &

from

)

Copy-constructs a UserError.

Parameters:

from	The UserError to copy from.

zorba::UserError::~UserError

(

)

Destroys this UserError.

---

Member Function Documentation

diagnostic::category zorba::UserError::category

(

)

const [virtual]

Gets the category of this diagnostic.

Returns:

Returns said category.

Reimplemented from zorba::Diagnostic.

Diagnostic const* zorba::UserError::clone

(

)

const [protected, virtual]

Implements zorba::Diagnostic.

virtual void zorba::Diagnostic::destroy

(

)

const [protected, virtual, inherited]

Destroys a Diagnostic.

This is the only way a Diagnostic should be destroyed.

Reimplemented in zorba::internal::SystemDiagnostic< QNameType >.

virtual diagnostic::kind zorba::Diagnostic::kind

(

)

const [virtual, inherited]

Gets the kind of this diagnostic.

Returns:

Returns said kind.

Reimplemented in zorba::internal::SystemDiagnostic< QNameType >.

Examples:

errors.cpp, external_functions.cpp, and simple.cpp.

virtual char const* zorba::Diagnostic::message

(

)

const [virtual, inherited]

Gets the message of this diagnostic.

Returns:

Returns said message.

UserError& zorba::UserError::operator=

(

UserError const &

from

)

Assigns this UserError from another.

Parameters:

from	The UserError to assign from.

Returns:

Returns *this.

diagnostic::QName const& zorba::UserError::qname

(

)

const [virtual]

Gets the QName for this diagnostic.

Returns:

Returns said QName.

Implements zorba::Diagnostic.

---

Friends And Related Function Documentation

UserError make_user_error	(	char const *	,
		char const *	,
		char const *
	)		[friend]

void serialization::operator&	(	serialization::Archiver &	,
		const Diagnostic *&
	)		[friend]

friend class UserException [friend]

Definition at line 93 of file error.h.

friend class ZorbaException [friend, inherited]

Definition at line 357 of file diagnostic.h.

---

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

• error.h