FatalError Class Reference

#include <FatalError.hpp>

Public Member Functions
	FatalError (string message, const char *file, int line, const char *function)
vector< string >	message () const

Private Attributes
vector< string >	_message

Detailed Description

This class represents a fatal error which can be thrown as an exception from anywhere in the application, even during parallel execution. The top-level function in the application should catch the exception and alert the user, including the message held by the FatalError instance. An instance of FatalError should be thrown by value and caught by reference.

Constructor & Destructor Documentation

FatalError()

FatalError::FatalError	(	string	message,
		const char *	file,
		int	line,
		const char *	function
	)

Constructs a fatal error with the specified error message and information about the call site. The error message can be split over multiple lines by using newline characters (backslash n) as usual. Rather than directly using this constructor, one should use the FATALERROR macro defined in this header to automatically include the source code location information. For example:

throw FATALERROR("Theta should be between 0 and pi.");

Member Function Documentation

message()

vector< string > FatalError::message

(

)

const

Returns the multi-line error message for this fatal error as a list of strings. Each string contains a single line, i.e. the strings contain no newline characters. The actual error message as passed to the constructor is contained in the first line(s). Subsequent lines describe the location in the source code where the exception was thrown, and provide a basic call stack overview.

---

The documentation for this class was generated from the following file:

• FatalError.hpp