coco::api_exception Class Reference
[Basic API utilities]
API exception class.
More...
#include <api_exception.h>
Inheritance diagram for coco::api_exception:
Public Member Functions | |
| api_exception (api_exception_type a, char const *m) | |
| api_exception (api_exception_type a, const std::string &m) | |
| virtual | ~api_exception () throw () |
| virtual char const * | what () const throw () |
| virtual api_exception_type | type () const throw () |
| virtual const char * | type_str () const throw () |
| virtual std::string | message () const throw () |
Detailed Description
This is the base class for all exceptions which are thrown by the API and the various modules of the COCONUT environment. Every properly coded COCONUT module should only throw this exception or some of its subclasses.Definition at line 69 of file api_exception.h.
Constructor & Destructor Documentation
| coco::api_exception::api_exception | ( | api_exception_type | a, | |
| char const * | m | |||
| ) | [inline] |
Constructor, setting the type to a and the message to m
Definition at line 79 of file api_exception.h.
| coco::api_exception::api_exception | ( | api_exception_type | a, | |
| const std::string & | m | |||
| ) | [inline] |
Constructor, setting the type to a and the message to m
Definition at line 82 of file api_exception.h.
| virtual coco::api_exception::~api_exception | ( | ) | throw () [inline, virtual] |
Standard Destructor
Definition at line 86 of file api_exception.h.
Member Function Documentation
| virtual std::string coco::api_exception::message | ( | ) | const throw () [inline, virtual] |
This method returns the message as C++-string.
Definition at line 104 of file api_exception.h.
| virtual api_exception_type coco::api_exception::type | ( | ) | const throw () [inline, virtual] |
This method returns the exception type as enum value.
Definition at line 95 of file api_exception.h.
| const char * coco::api_exception::type_str | ( | ) | const throw () [virtual] |
This method returns the exception type as C-string.
Definition at line 57 of file api_exception.cc.
| virtual char const* coco::api_exception::what | ( | ) | const throw () [inline, virtual] |
This method returns the message as C-string.
Definition at line 89 of file api_exception.h.
The documentation for this class was generated from the following files:
