#include <OpenMS/CONCEPT/Exception.h>
Public Member Functions | |
Constructors and Destructors | |
| BaseException () throw () | |
| Default constructor. | |
| BaseException (const char *file, int line, const char *function) throw () | |
| Constructor. | |
| BaseException (const char *file, int line, const char *function, const std::string &name, const std::string &message) throw () | |
| Constructor. | |
| BaseException (const BaseException &exception) throw () | |
| Copy constructor. | |
| virtual | ~BaseException () throw () |
| Destructor. | |
Accessors | |
| const char * | getName () const throw () |
| Returns the name of the exception. | |
| virtual const char * | what () const throw () |
| Returns the error message of the exception. | |
| int | getLine () const throw () |
| Returns the line number where it occured. | |
| const char * | getFile () const throw () |
| Returns the file where it occured. | |
| const char * | getFunction () const throw () |
| Returns the function where it occured. | |
| const char * | getMessage () const throw () |
| Returns the message. | |
| void | setMessage (const std::string &message) throw () |
| Modify the exception's error message. | |
Protected Attributes | |
| const char * | file_ |
| The source file the exception was thrown in. | |
| int | line_ |
| The line number the exception was thrown in. | |
| const char * | function_ |
| The source file the exception was thrown in. | |
| std::string | name_ |
| The name of the exception. | |
| std::string | what_ |
| A more detailed description of the exception's cause. | |
Detailed Description
Exception base class.
This class is intended as a base class for all other exceptions.
Each exception class should define a constructor taking a filename (string), line (int) and function name (string) as first agruments. This information is usually printed in case of an uncaught exception.
To support this feature, each throw directive should look as follows:
throw Exception::Exception(__FILE__, __LINE__, __PRETTY_FUNCTION__,...);
__FILE__ and __LINE__ are built-in preprocessor macros that hold the desired information.
__PRETTY_FUNCTION__ is replaced by the GNU G++ compiler with the demangled name of the current function. (For other compilers it is defined as "<unknown>" in config.h.)
OpenMS provides its own Exception::GlobalExceptionHandler::terminate() handler. This handler extracts as much information as possible from the exception, prints it to cerr , and finally calls exits the program cleanly (with exit code 1). This can be rather inconvenient for debugging, since you are told where the exception was thrown, but in general you do not know anything about the context. Therefore terminate() can also create a core dump. Using a debugger (e.g. dbx or gdb) you can then create a stack traceback. To create a core dump, you should set the environment variable OPENMS_DUMP_CORE to any (non empty) value.
Constructor & Destructor Documentation
| BaseException | ( | ) | throw () |
Default constructor.
| BaseException | ( | const char * | file, | |
| int | line, | |||
| const char * | function | |||
| ) | throw () |
Constructor.
| BaseException | ( | const char * | file, | |
| int | line, | |||
| const char * | function, | |||
| const std::string & | name, | |||
| const std::string & | message | |||
| ) | throw () |
Constructor.
| BaseException | ( | const BaseException & | exception | ) | throw () |
Copy constructor.
| virtual ~BaseException | ( | ) | throw () [virtual] |
Destructor.
Member Function Documentation
| const char* getFile | ( | ) | const throw () |
Returns the file where it occured.
Referenced by MzMLFile::load(), and main().
| const char* getFunction | ( | ) | const throw () |
Returns the function where it occured.
Referenced by MzMLFile::load().
| int getLine | ( | ) | const throw () |
Returns the line number where it occured.
Referenced by MzMLFile::load(), and main().
| const char* getMessage | ( | ) | const throw () |
Returns the message.
Referenced by QApplicationTOPP::notify().
| const char* getName | ( | ) | const throw () |
Returns the name of the exception.
Referenced by MzMLFile::load(), QApplicationTOPP::notify(), FeatureFinderAlgorithmSimplest< PeakType, FeatureType >::run(), and FeatureFinderAlgorithmSimple< PeakType, FeatureType >::run().
| void setMessage | ( | const std::string & | message | ) | throw () |
Modify the exception's error message.
| virtual const char* what | ( | ) | const throw () [virtual] |
Returns the error message of the exception.
Referenced by TOPPViewBase::addDataDB(), TOPPViewBase::addDataFile(), TOPPViewBase::annotateWithID(), TOPPViewBase::connectToDB_(), TOPPViewBase::copyLayer(), TOPPViewBase::fileChanged_(), main(), TOPPViewBase::metadataDatabaseDialog(), TOPPViewBase::metadataFileDialog(), FeatureFinderAlgorithmSimplest< PeakType, FeatureType >::run(), and TOPPViewBase::showSpectrumGenerationDialog().
Member Data Documentation
const char* file_ [protected] |
The source file the exception was thrown in.
const char* function_ [protected] |
The source file the exception was thrown in.
int line_ [protected] |
The line number the exception was thrown in.
std::string name_ [protected] |
The name of the exception.
std::string what_ [protected] |
A more detailed description of the exception's cause.
| OpenMS / TOPP release 1.10.0 | Documentation generated on Thu Mar 7 2013 09:42:59 using doxygen 1.7.1 |