CMS API Exception that is the base for all exceptions thrown from CMS classes.
More...
Public Member Functions |
| CMSException () |
| CMSException (const CMSException &ex) |
| CMSException (const std::string &message) |
| CMSException (const std::string &message, const std::exception *cause) |
| CMSException (const std::string &message, const std::exception *cause, const std::vector< std::pair< std::string, int > > &stackTrace) |
virtual | ~CMSException () throw () |
virtual std::string | getMessage () const |
| Gets the cause of the error.
|
virtual const std::exception * | getCause () const |
| Gets the exception that caused this one to be thrown, this allows for chaining of exceptions in the case of a method that throws only a particular exception but wishes to allow for the real causal exception to be passed only in case the caller knows about that type of exception and wishes to respond to it.
|
virtual std::vector< std::pair
< std::string, int > > | getStackTrace () const |
| Provides the stack trace for every point where this exception was caught, marked, and rethrown.
|
virtual void | setMark (const char *file, const int lineNumber) |
| Adds a file/line number to the stack trace.
|
virtual void | printStackTrace () const |
| Prints the stack trace to std::err.
|
virtual void | printStackTrace (std::ostream &stream) const |
| Prints the stack trace to the given output stream.
|
virtual std::string | getStackTraceString () const |
| Gets the stack trace as one contiguous string.
|
virtual const char * | what () const throw () |
| Overloads the std::exception what() function to return the cause of the exception.
|
virtual CMSException * | clone () |
| Creates a cloned version of this CMSException instance.
|
CMS API Exception that is the base for all exceptions thrown from CMS classes.
This class represents an error that has occurred in CMS, providers can wrap provider specific exceptions in this class by setting the cause to an instance of a provider specific exception provided it can be cast to an std::exception.
Since the contained cause exception is of type std::exception and the C++ exception class has no clone or copy method defined the contained exception can only be owned by one instance of an CMSException. To that end the class hands off the exception to each successive copy or clone so care must be taken when handling CMSException instances.
- Since
- 1.0