RWxmsg Class Reference

Base class for the hierarchy of exceptions in the Essential Tools Module. More...

#include <rw/rwerr.h>

Inheritance diagram for RWxmsg:

Public Member Functions
	RWxmsg (const char *msg)
	RWxmsg (const RWxmsg &msg)
	RWxmsg (RWxmsg &&msg)
RWxmsg &	operator= (const RWxmsg &)
RWxmsg &	operator= (RWxmsg &&msg)
virtual void	raise () const
void	swap (RWxmsg &rhs)
virtual const char *	why () const

Protected Member Functions
	RWxmsg (const char *msg, bool doCopy)

Related Functions
(Note that these are not member functions.)
#define	RWTHROW(a)

Detailed Description

This class is the base class for the hierarchy of exceptions in the Essential Tools Module. (See the section on error reporting and handling in the Essential Tools Module User's Guide.) Although the entire class is documented here, your code usually should not create or directly throw RWxmsg objects. Instead, you should expect to write code that may catch an RWxmsg or one of its derived classes.

Essential Tools Module classes that need to report exceptional circumstances call RWTHROW(). RWTHROW() throws the RWxmsg if exceptions are enabled. Otherwise, RWTHROW() calls an appropriate current Essential Tools Module error handler function (see the section on error reporting and handling in the Essential Tools Module User's Guide).

RWxmsg provides a basic interface for exceptions, from which an exception string is always available. This exception string is obtained through the why() method, and is represented as a const char*, single-byte character sequence.

Synopsis

#include <rw/rwerr.h>
RWxmsg x("exception message");

Persistence

None

Constructor & Destructor Documentation

RWxmsg::RWxmsg

(

const char *

msg

)

Creates an exception that returns msg when its why() method is called.

RWxmsg::RWxmsg

(

const RWxmsg &

msg

)

Copy constructor.

RWxmsg::RWxmsg

(

RWxmsg &&

msg

)

Move constructor. The constructed instance takes ownership of the data owned by msg.

Condition:

This method is available only on platforms with rvalue reference support.

RWxmsg::RWxmsg ( const char *  msg, bool  doCopy  )

protected

Creates an exception that returns msg when its why() method is called. If doCopy is true, copies msg into a new buffer on the heap, otherwise simply keeps a pointer to the given location of msg.

Member Function Documentation

RWxmsg& RWxmsg::operator=

(

const RWxmsg &

)

Assignment operator.

RWxmsg& RWxmsg::operator=

(

RWxmsg &&

msg

)

Move assignment. Self takes ownership of the data owned by msg.

Condition:

This method is available only on platforms with rvalue reference support.

virtual void RWxmsg::raise ( ) const

virtual

Calls RWTHROW(), passing self as a parameter.

Reimplemented in RWTHRxmsg, RWCancellation, RWTTHRCompatibleException< Exception >, RWTHRIllegalAccess, RWTHRIllegalUsage, RWTHRInvalidPointer, RWTHRBoundsError, RWTHRExternalError, RWTHROperationAborted, RWTHROperationNotAvailable, RWTHROperationNotSupported, RWTHROperationTerminated, RWTHRResourceLimit, RWTHRThreadActive, RWTHRThreadNotActive, RWTHRClosedException, RWTHRInternalError, RWTHROperationCanceled, RWTHROperationNotImplemented, RWTHRPermissionError, and RWTHREscrowAlreadyClosed.

void RWxmsg::swap

(

RWxmsg &

rhs

)

Swaps the data owned by self with the data owned by rhs.

virtual const char* RWxmsg::why ( ) const

virtual

Returns the message string contained in self.

Friends And Related Function Documentation

#define RWTHROW (   a )

related

RWTHROW() throws the exception a if exceptions are enabled. Otherwise, RWTHROW() invokes the error handler callback function set by the last call to rwSetErrHandler() or the default callback if one has not been explicitly set.