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

The StateException class is used for error cases of sounds or readers with illegal states or requirements for states of dependent classes. More...

#include <Exception.h>

Inheritance diagram for StateException:
Inheritance graph
[legend]

Public Member Functions

 StateException (const std::string &message, const std::string &file, int line)
 Creates a new StateException object.
 
 StateException (const StateException &exception)
 Copy constructor.
 
- Public Member Functions inherited from Exception
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.
 

Additional Inherited Members

- Protected Member Functions inherited from Exception
 Exception (const Exception &exception)
 Copy constructor.
 
 Exception (const std::string &message, const std::string &file, int line)
 Creates a new Exception object.
 
- Protected Attributes inherited from Exception
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 StateException class is used for error cases of sounds or readers with illegal states or requirements for states of dependent classes.

It is used for example when an effect reader needs a specific specification from its input.

Constructor & Destructor Documentation

◆ StateException() [1/2]

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

Creates a new StateException 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.

◆ StateException() [2/2]

StateException::StateException ( const StateException & exception)

Copy constructor.

Parameters
exceptionThe exception to be copied.

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