RuntimeUserException Class Reference

A generic exception the user can throw at runtime. More...

Inheritance diagram for RuntimeUserException:

Public Member Functions
	RuntimeUserException (const char *reason) throw ()
	Constructor. More...
	RuntimeUserException (const RuntimeUserException &other) throw ()
	Copy constructor. More...
virtual	~RuntimeUserException () throw ()
	Destructor. More...
RuntimeUserException &	operator= (const RuntimeUserException &other) throw ()
	Copy operator. More...
const char *	reason () const throw ()
	Returns the description of why the exception was thrown. More...
virtual const char *	what () const throw ()
	Returns a C string describing the exception. More...

Detailed Description

A generic exception the user can throw at runtime.

You can use this when you need to throw an exception at runtime. This simply has a string description of the error you can set when creating the instance. You can use the utility function throwUserRuntimeError() to throw the exception. The function takes a QString parameter, so it is easy to format the error message.

Definition at line 52 of file utilitiesexceptions.h.

Constructor & Destructor Documentation

RuntimeUserException ( const char *  reason ) throw ( )

inline

Constructor.

Parameters

reason

the description of why the exception was thrown. The buffer for this is at most 256 characters (including the '\0' terminator)

Definition at line 62 of file utilitiesexceptions.h.

RuntimeUserException ( const RuntimeUserException &  other ) throw ( )

inline

Copy constructor.

Parameters

other

the exception to copy

Definition at line 76 of file utilitiesexceptions.h.

virtual ~RuntimeUserException ( ) throw ( )

inlinevirtual

Destructor.

Definition at line 108 of file utilitiesexceptions.h.

Member Function Documentation

RuntimeUserException& operator= ( const RuntimeUserException &  other ) throw ( )

inline

Copy operator.

Parameters

other

the exception to copy

Definition at line 90 of file utilitiesexceptions.h.

const char* reason ( ) const throw ( )

inline

Returns the description of why the exception was thrown.

Returns

the description of why the exception was thrown

Definition at line 127 of file utilitiesexceptions.h.

virtual const char* what ( ) const throw ( )

inlinevirtual

Returns a C string describing the exception.

Returns

a C string describing the exception

Definition at line 117 of file utilitiesexceptions.h.

---

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

• utilities/include/utilitiesexceptions.h