ctkPluginException Class Reference

#include <Libs/PluginFramework/ctkPluginException.h>

Inheritance diagram for ctkPluginException:

Collaboration diagram for ctkPluginException:

Public Types
enum	Type {   UNSPECIFIED , UNSUPPORTED_OPERATION , INVALID_OPERATION , MANIFEST_ERROR ,   RESOLVE_ERROR , ACTIVATOR_ERROR , SECURITY_ERROR , STATECHANGE_ERROR ,   DUPLICATE_PLUGIN_ERROR , READ_ERROR , START_TRANSIENT_ERROR }

Public Member Functions
ctkPluginException *	clone () const
	ctkPluginException (const ctkPluginException &o)
	ctkPluginException (const QString &msg, const ctkException &cause)
	ctkPluginException (const QString &msg, const Type &type, const ctkException &cause)
	ctkPluginException (const QString &msg, const Type &type=UNSPECIFIED)
Type	getType () const
const char *	name () const throw ()
ctkPluginException &	operator= (const ctkPluginException &o)
void	rethrow () const
	~ctkPluginException () throw ()
Public Member Functions inherited from ctkRuntimeException
	ctkRuntimeException (const ctkRuntimeException &exc)
	ctkRuntimeException (const QString &msg)
	ctkRuntimeException (const QString &msg, const ctkException &exc)
ctkRuntimeException &	operator= (const ctkRuntimeException &exc)
	~ ctkRuntimeException () throw ()
Public Member Functions inherited from ctkException
const ctkException *	cause () const throw ()
	Gets the nested exception which caused this exception. More...
virtual const char *	className () const throw ()
	Returns the class name for this exception. More...
	ctkException (const ctkException &o)
	Copy constructor. More...
	ctkException (const QString &msg)
	Create a new ctkException. More...
	ctkException (const QString &msg, const ctkException &cause)
	Create a new ctkException containing another exception as the cause. More...
QString	message () const throw ()
	Returns the detail message string of this exception. More...
ctkException &	operator= (const ctkException &o)
	Assignment operator. More...
TraceManipulator	printStackTrace () const
	Returns an object suitable for printing this executable and its backtrace via qDebug(). More...
void	setCause (const ctkException &cause)
	Sets the cause for this exception. More...
virtual const char *	what () const throw ()
	Returns a static string describing this exception. More...
	~ctkException () throw ()
Public Member Functions inherited from ctkBackTrace
	ctkBackTrace (const ctkBackTrace &other)
	ctkBackTrace (size_t framesNumber=DefaultStackSize)
	Create a back trace. More...
void *	returnAddress (unsigned frameNumber) const
	Get the return address for a given stack frame. More...
QString	stackFrame (unsigned frameNumber) const
	Get a textual representation for a given stack frame. More...
size_t	stackSize () const
	Get the stack size. More...
QList< QString >	stackTrace () const
	Provides programmatic access to the stack trace information. More...
virtual	~ctkBackTrace () throw ()

Additional Inherited Members
Static Public Attributes inherited from ctkBackTrace
static size_t const	DefaultStackSize
Protected Member Functions inherited from ctkException
virtual QDebug	printStackTrace (QDebug dbg) const
	Print the stack trace of this exception using the given QDebug object. More...

Detailed Description

A Plugin Framework exception used to indicate that a plugin lifecycle problem occurred.

A ctkPluginException object is created by the Framework to denote an exception condition in the lifecycle of a plugin. ctkPluginExceptions should not be created by plugin developers. An enum type is used to identify the exception type for future extendability.

This exception conforms to the general purpose exception chaining mechanism.

Definition at line 44 of file ctkPluginException.h.

Member Enumeration Documentation

Type

enum ctkPluginException::Type

Enumerator
UNSPECIFIED	No exception type is unspecified.
UNSUPPORTED_OPERATION	The operation was unsupported.
INVALID_OPERATION	The operation was invalid.
MANIFEST_ERROR	The plugin manifest contains errors.
RESOLVE_ERROR	The plugin was not resolved.
ACTIVATOR_ERROR	The plugin activator was in error.
SECURITY_ERROR	The operation failed due to insufficient permissions.
STATECHANGE_ERROR	The operation failed to complete the requested lifecycle state change.
DUPLICATE_PLUGIN_ERROR	The install or update operation failed because another already installed plugin has the same symbolic name and version.
READ_ERROR	The framework received an error while reading the input stream for a plugin.
START_TRANSIENT_ERROR	The start transient operation failed because the start level of the plugin is greater than the current framework start level

Definition at line 48 of file ctkPluginException.h.

Constructor & Destructor Documentation

ctkPluginException() [1/4]

ctkPluginException::ctkPluginException	(	const QString &	msg,
		const Type &	type = UNSPECIFIED
	)

Creates a ctkPluginException with the specified message and type.

Parameters

msg	The associated message.
type	The type for this exception.

ctkPluginException() [2/4]

ctkPluginException::ctkPluginException	(	const QString &	msg,
		const Type &	type,
		const ctkException &	cause
	)

Creates a ctkPluginException with the specified message, type and exception cause.

Parameters

msg	The associated message.
type	The type for this exception.
cause	The cause of this exception.

ctkPluginException() [3/4]

ctkPluginException::ctkPluginException	(	const QString &	msg,
		const ctkException &	cause
	)

Creates a ctkPluginException with the specified message and exception cause.

Parameters

msg	The associated message.
cause	The cause of this exception.

ctkPluginException() [4/4]

ctkPluginException::ctkPluginException

(

const ctkPluginException &

o

)

~ctkPluginException()

ctkPluginException::~ctkPluginException	(		)
throw	(
	)

Member Function Documentation

clone()

ctkPluginException* ctkPluginException::clone ( ) const

virtual

See also

ctkException::clone()

Reimplemented from ctkRuntimeException.

getType()

Type ctkPluginException::getType

(

)

const

Returns the type for this exception or UNSPECIFIED if the type was unspecified or unknown.

Returns

The type of this exception.

name()

const char* ctkPluginException::name ( ) const throw ( )

virtual

See also

ctkException::name()

Reimplemented from ctkRuntimeException.

operator=()

ctkPluginException& ctkPluginException::operator=

(

const ctkPluginException &

o

)

rethrow()

void ctkPluginException::rethrow ( ) const

virtual

See also

ctkException::rethrow()

Reimplemented from ctkRuntimeException.

---

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

• Libs/PluginFramework/ctkPluginException.h