Voxel
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Exception Struct Reference

Default exception class. More...

#include <exception.h>

Public Member Functions

 Exception (char const *const file, unsigned int const line, std::string const &what)
 Exception (char const *const file, unsigned int const line, std::string const &what, char const *const message)
virtual const char * what () const throw ()
 Returns text (UTF-8) error message for this exception.

Detailed Description

Default exception class.

Exceptions should not be constructed explicitly. Instead, use the THROW_EXCEPTION() and THROW_EXCEPTION_MESSAGE() macros, which will construct and throw exceptions annotated with the filename and line number of the failure.

The error message returned by what() has the following components:

  1. Filename and line number at which the exception was thrown.
  2. Description string what passed to the constructor.
  3. (Optional) string message passed to the constructor, intended to be used to store error messages from external libraries (although the WindowsException and OpenCL::Exception classes handle this for HRESULT error codes and OpenCL error codes, respectively).

Definition at line 56 of file exception.h.


The documentation for this struct was generated from the following files: