BaseException Class Reference

Exception base class. More...

#include <OpenMS/CONCEPT/Exception.h>

Inheritance diagram for BaseException:

Public Member Functions
Constructors and Destructors
	BaseException () noexcept
	Default constructor. More...
	BaseException (const char *file, int line, const char *function) noexcept
	Constructor. More...
	BaseException (const char *file, int line, const char *function, const std::string &name, const std::string &message) noexcept
	Constructor. More...
	BaseException (const BaseException &exception) noexcept
	Copy constructor. More...
virtual	~BaseException () noexcept
	Destructor. More...
Accessors
const char *	getName () const noexcept
	Returns the name of the exception. More...
virtual const char *	what () const noexcept
	Returns the error message of the exception. More...
int	getLine () const noexcept
	Returns the line number where it occurred. More...
const char *	getFile () const noexcept
	Returns the file where it occurred. More...
const char *	getFunction () const noexcept
	Returns the function where it occurred. More...
const char *	getMessage () const noexcept
	Returns the message. More...
void	setMessage (const std::string &message) noexcept
	Modify the exception's error message. More...

Protected Attributes
const char *	file_
	The source file the exception was thrown in. More...
int	line_
	The line number the exception was thrown in. More...
const char *	function_
	The source file the exception was thrown in. More...
std::string	name_
	The name of the exception. More...
std::string	what_
	A more detailed description of the exception's cause. More...

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 arguments. 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__, OPENMS_PRETTY_FUNCTION,...); 

__FILE__ and __LINE__ are built-in preprocessor macros that hold the desired information.
OPENMS_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() [1/4]

BaseException ( )

noexcept

Default constructor.

BaseException() [2/4]

BaseException ( const char *  file, int  line, const char *  function  )

noexcept

Constructor.

BaseException() [3/4]

BaseException ( const char *  file, int  line, const char *  function, const std::string &  name, const std::string &  message  )

noexcept

Constructor.

BaseException() [4/4]

BaseException ( const BaseException &  exception )

noexcept

Copy constructor.

~BaseException()

virtual ~BaseException ( )

virtualnoexcept

Destructor.

Member Function Documentation

getFile()

const char* getFile ( ) const

noexcept

Returns the file where it occurred.

Referenced by main().

getFunction()

const char* getFunction ( ) const

noexcept

Returns the function where it occurred.

getLine()

int getLine ( ) const

noexcept

Returns the line number where it occurred.

Referenced by main().

getMessage()

const char* getMessage ( ) const

noexcept

Returns the message.

Referenced by QApplicationTOPP::notify().

getName()

const char* getName ( ) const

noexcept

Returns the name of the exception.

Referenced by QApplicationTOPP::notify().

setMessage()

void setMessage ( const std::string &  message )

noexcept

Modify the exception's error message.

what()

virtual const char* what ( ) const

virtualnoexcept

Returns the error message of the exception.

Referenced by TOPPViewBase::addDataFile(), TOPPViewBase::annotateWithID(), TOPPViewBase::copyLayer(), TOPPViewBase::fileChanged_(), main(), TOPPViewBase::metadataFileDialog(), and TOPPViewBase::showSpectrumGenerationDialog().

Member Data Documentation

file_

const char* file_

protected

The source file the exception was thrown in.

function_

const char* function_

protected

The source file the exception was thrown in.

line_

int line_

protected

The line number the exception was thrown in.

name_

std::string name_

protected

The name of the exception.

what_

std::string what_

protected

A more detailed description of the exception's cause.