UserRequiredResourceMissingException Class Reference

The exception to throw when a user needs a resouce during configuration which doesn't exist. More...

Inheritance diagram for UserRequiredResourceMissingException:

Public Member Functions

 UserRequiredResourceMissingException (const char *resourceName, const char *description) throw ()
 Constructor. More...
 
 UserRequiredResourceMissingException (const UserRequiredResourceMissingException &other) throw ()
 Copy constructor. More...
 
virtual ~UserRequiredResourceMissingException () throw ()
 Destructor. More...
 
const char * description () const throw ()
 Returns the error description. More...
 
UserRequiredResourceMissingExceptionoperator= (const UserRequiredResourceMissingException &other) throw ()
 Copy operator. More...
 
const char * resourceName () const throw ()
 Returns the name of the resource. More...
 
virtual const char * what () const throw ()
 Returns a C string describing the exception. More...
 

Detailed Description

The exception to throw when a user needs a resouce during configuration which doesn't exist.

Use this when a resource requested during the configuration phase is missing. The ConfigurationHelper::throwUserMissingResourceError() function provides a convenient way of throwing an exception of this type (see function description)

Definition at line 1606 of file configurationexceptions.h.

Constructor & Destructor Documentation

UserRequiredResourceMissingException ( const char *  resourceName,
const char *  description 
)
throw (
)
inline

Constructor.

Parameters
resourceNamethe name of the resource requested but not found. The buffer for this is at most 256 characters (including the '\0' terminator)
descriptiona description of the error. The buffer for this is at most 256 characters (including the '\0' terminator)

Definition at line 1619 of file configurationexceptions.h.

Copy constructor.

Parameters
otherthe exception to copy

Definition at line 1635 of file configurationexceptions.h.

virtual ~UserRequiredResourceMissingException ( )
throw (
)
inlinevirtual

Destructor.

Definition at line 1671 of file configurationexceptions.h.

Member Function Documentation

const char* description ( ) const
throw (
)
inline

Returns the error description.

Returns
the error description

Definition at line 1700 of file configurationexceptions.h.

UserRequiredResourceMissingException& operator= ( const UserRequiredResourceMissingException other)
throw (
)
inline

Copy operator.

Parameters
otherthe exception to copy

Definition at line 1651 of file configurationexceptions.h.

const char* resourceName ( ) const
throw (
)
inline

Returns the name of the resource.

Returns
the name of the resource

Definition at line 1690 of file configurationexceptions.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 1680 of file configurationexceptions.h.


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