Audaspace 1.5.0
A high level audio library.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Exception Class Reference

The Exception class is the general exception base class. More...

#include <Exception.h>

Inheritance diagram for Exception:
Inheritance graph
[legend]

Public Member Functions

virtual ~Exception () AUD_NOEXCEPT
 Destroys the object.
 
virtual const char * what () const AUD_NOEXCEPT
 Returns the error message.
 
virtual std::string getDebugMessage () const
 Returns the error message plus file and line number for debugging purposes.
 
const std::string & getMessage () const
 Returns the error message.
 
const std::string & getFile () const
 Returns the file in which the exception was thrown.
 
int getLine () const
 Returns the line where the exception was originally thrown.
 

Protected Member Functions

 Exception (const Exception &exception)
 Copy constructor.
 
 Exception (const std::string &message, const std::string &file, int line)
 Creates a new Exception object.
 

Protected Attributes

const std::string m_message
 A message describing the problem.
 
const std::string m_file
 The source code file in which the exception was thrown.
 
const int m_line
 The source code line from which the exception was thrown.
 

Detailed Description

The Exception class is the general exception base class.

Constructor & Destructor Documentation

◆ Exception() [1/2]

Exception::Exception ( const Exception & exception)
protected

Copy constructor.

Parameters
exceptionThe exception to be copied.

◆ Exception() [2/2]

Exception::Exception ( const std::string & message,
const std::string & file,
int line )
protected

Creates a new Exception object.

Parameters
messageA message describing the problem.
fileThe source code file in which the exception was thrown.
lineThe source code line from which the exception was thrown.

Member Function Documentation

◆ getDebugMessage()

virtual std::string Exception::getDebugMessage ( ) const
virtual

Returns the error message plus file and line number for debugging purposes.

Returns
The error message including debug information.

◆ getFile()

const std::string & Exception::getFile ( ) const

Returns the file in which the exception was thrown.

Returns
The name of the file in which the exception was thrown.

◆ getLine()

int Exception::getLine ( ) const

Returns the line where the exception was originally thrown.

Returns
The line of the source file where the exception was generated.

◆ getMessage()

const std::string & Exception::getMessage ( ) const

Returns the error message.

Returns
The error message as string.

◆ what()

virtual const char * Exception::what ( ) const
virtual

Returns the error message.

Returns
A C string error message.

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