castor::Exception Class Reference

#include <Exception.hpp>

Inheritance diagram for castor::Exception:

Collaboration diagram for castor::Exception:

Public Member Functions
	Exception (MbString const &description, char const *file, char const *function, uint32_t line)
	Specified constructor.
	Exception (WString const &description, char const *file, char const *function, uint32_t line)
	Specified constructor.
char const *	what () const noexcept override
	Retrieves the exception description.
MbString const &	getFileName () const noexcept
	Retrieves the file name.
MbString const &	getFunction () const noexcept
	Retrieves the function name.
uint32_t	getLine () const noexcept
	Retrieves the line number.
MbString const &	getDescription () const noexcept
	Retrieves the exception description.
MbString	getFullDescription () const noexcept
	Retrieves the full exception text (description, line, file and function.

Protected Attributes
uint32_t	m_line
MbString	m_description
MbString	m_filename
MbString	m_functionName
MbString	m_callStack

Constructor & Destructor Documentation

Exception() [1/2]

castor::Exception::Exception ( MbString const & description, char const * file, char const * function, uint32_t line )

inline

Specified constructor.

Parameters

[in]	description	The exception description
[in]	file	The file name
[in]	function	The function name
[in]	line	The line number

References m_callStack, castor::makeStringStream(), and castor::toUtf8().

Here is the call graph for this function:

Exception() [2/2]

castor::Exception::Exception ( WString const & description, char const * file, char const * function, uint32_t line )

inline

Specified constructor.

Parameters

[in]	description	The exception description
[in]	file	The file name
[in]	function	The function name
[in]	line	The line number

Member Function Documentation

getDescription()

MbString const & castor::Exception::getDescription ( ) const

inlinenoexcept

Retrieves the exception description.

Returns

The exception description

References m_description.

getFileName()

MbString const & castor::Exception::getFileName ( ) const

inlinenoexcept

Retrieves the file name.

Returns

The file name

References m_filename.

getFullDescription()

MbString castor::Exception::getFullDescription ( ) const

inlinenoexcept

Retrieves the full exception text (description, line, file and function.

Returns

The full exception text

References m_callStack, m_description, m_filename, m_functionName, and m_line.

getFunction()

MbString const & castor::Exception::getFunction ( ) const

inlinenoexcept

Retrieves the function name.

Returns

The function name

References m_functionName.

getLine()

uint32_t castor::Exception::getLine ( ) const

inlinenoexcept

Retrieves the line number.

Returns

The line number

References m_line.

what()

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

inlineoverridenoexcept

Retrieves the exception description.

Returns

The exception description

References m_description.

Member Data Documentation

m_callStack

MbString castor::Exception::m_callStack

protected

Referenced by Exception(), and getFullDescription().

m_description

MbString castor::Exception::m_description

protected

Referenced by getDescription(), getFullDescription(), and what().

m_filename

MbString castor::Exception::m_filename

protected

Referenced by getFileName(), and getFullDescription().

m_functionName

MbString castor::Exception::m_functionName

protected

Referenced by getFullDescription(), and getFunction().

m_line

uint32_t castor::Exception::m_line

protected

Referenced by getFullDescription(), and getLine().

---

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

• CastorUtils/Exception/Exception.hpp