UserRequiredResourceMissingException Class Reference
The exception to throw when a user needs a resouce during configuration which doesn't exist. More...
Public Member Functions | |
UserRequiredResourceMissingException (const char *resourceName, const char *description) throw () | |
Constructor. | |
UserRequiredResourceMissingException (const UserRequiredResourceMissingException &other) throw () | |
Copy constructor. | |
virtual | ~UserRequiredResourceMissingException () throw () |
Destructor. | |
const char * | description () const throw () |
Returns the error description. | |
UserRequiredResourceMissingException & | operator= (const UserRequiredResourceMissingException &other) throw () |
Copy operator. | |
const char * | resourceName () const throw () |
Returns the name of the resource. | |
virtual const char * | what () const throw () |
Returns a C string describing the exception. |
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 1505 of file configurationexceptions.h.
Constructor & Destructor Documentation
UserRequiredResourceMissingException | ( | const char * | resourceName, |
const char * | description | ||
) | throw () [inline] |
Constructor.
- Parameters:
-
resourceName the name of the resource requested but not found. The buffer for this is at most 256 characters (including the '\0' terminator) description a description of the error. The buffer for this is at most 256 characters (including the '\0' terminator)
Definition at line 1518 of file configurationexceptions.h.
UserRequiredResourceMissingException | ( | const UserRequiredResourceMissingException & | other | ) | throw () [inline] |
Copy constructor.
- Parameters:
-
other the exception to copy
Definition at line 1534 of file configurationexceptions.h.
virtual ~UserRequiredResourceMissingException | ( | ) | throw () [inline, virtual] |
Destructor.
Definition at line 1570 of file configurationexceptions.h.
Member Function Documentation
const char* description | ( | ) | const throw () [inline] |
Returns the error description.
- Returns:
- the error description
Definition at line 1599 of file configurationexceptions.h.
UserRequiredResourceMissingException& operator= | ( | const UserRequiredResourceMissingException & | other | ) | throw () [inline] |
Copy operator.
- Parameters:
-
other the exception to copy
Definition at line 1550 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 1589 of file configurationexceptions.h.
virtual const char* what | ( | ) | const throw () [inline, virtual] |
Returns a C string describing the exception.
- Returns:
- a C string describing the exception
Definition at line 1579 of file configurationexceptions.h.
The documentation for this class was generated from the following file:
- configuration/include/configurationexceptions.h