API Documentation
Loading...
Searching...
No Matches
Exception Class Reference

#include <Exception.hpp>

Inheritance diagram for Exception:
[legend]
Collaboration diagram for Exception:
[legend]

Public Member Functions

virtual ~Exception ()=default
 
NDEVR_BASE_API Exception (const String &title, const bool &capture_stack=true)
 
NDEVR_BASE_API Exception (const TranslatedString &title, const bool &capture_stack=true)
 
NDEVR_BASE_API Exception (const std::exception &exception)
 
NDEVR_BASE_API Exception (const TranslatedString &title, const TranslatedString &message, const bool &capture_stack=true)
 
void setTitle (const TranslatedString &title)
 
virtual void setMessage (const TranslatedString &message)
 
void setCategory (const TranslatedString &category)
 
void setThread (const String &thread)
 
virtual TranslatedString getMessage () const
 
virtual const TranslatedStringgetTitle () const
 
virtual const TranslatedStringgetCategory () const
 
virtual const StringstackTrace () const
 
virtual uint04 getPriority () const
 
const Stringthread () const
 
NDEVR_BASE_API UUID id () const
 
void printToLogger ()
 

Protected Attributes

TranslatedString m_message
 
TranslatedString m_title
 
TranslatedString m_category
 
String m_thread
 
String m_stack_trace
 
uint04 m_priority
 

Constructor & Destructor Documentation

◆ ~Exception()

virtual ~Exception ( )
virtualdefault

◆ Exception() [1/4]

Exception ( const String & title,
const bool & capture_stack = true )

Fn: Exception::Exception(const char* message)

Constructor.

Author: Tyler Parke

Date: 2017-11-17

Parameters:

message - The message that identifies the exception.

◆ Exception() [2/4]

Exception ( const TranslatedString & title,
const bool & capture_stack = true )

◆ Exception() [3/4]

Exception ( const std::exception & exception)

◆ Exception() [4/4]

Exception ( const TranslatedString & title,
const TranslatedString & message,
const bool & capture_stack = true )

Member Function Documentation

◆ getCategory()

virtual const TranslatedString & getCategory ( ) const
inlinevirtual

◆ getMessage()

virtual TranslatedString getMessage ( ) const
inlinevirtual

Fn: const char* Exception::getMessage() const

Gets the message identifying the exception

Author: Tyler Parke

Date: 2017-11-17

Returns: Null if it fails, else the message.

◆ getPriority()

virtual uint04 getPriority ( ) const
inlinevirtual

◆ getTitle()

virtual const TranslatedString & getTitle ( ) const
inlinevirtual

◆ id()

UUID id ( ) const

◆ printToLogger()

void printToLogger ( )

◆ setCategory()

void setCategory ( const TranslatedString & category)
inline

Fn: void Exception::setCategory(const String& message)

Sets a message.

Author: Tyler Parke

Date: 2017-11-17

Parameters:

message - The message.

◆ setMessage()

virtual void setMessage ( const TranslatedString & message)
inlinevirtual

Reimplemented in GraphicsException.

◆ setThread()

void setThread ( const String & thread)
inline

◆ setTitle()

void setTitle ( const TranslatedString & title)
inline

Fn: void Exception::setTitle(const String& title)

Sets a title for the exception.

Author: Tyler Parke

Date: 2018-07-09

Parameters:

title - The title of the exception.

◆ stackTrace()

virtual const String & stackTrace ( ) const
inlinevirtual

◆ thread()

const String & thread ( ) const
inline

Member Data Documentation

◆ m_category

TranslatedString m_category
protected

◆ m_message

TranslatedString m_message
protected

◆ m_priority

uint04 m_priority
protected

◆ m_stack_trace

String m_stack_trace
protected

◆ m_thread

String m_thread
protected

◆ m_title

TranslatedString m_title
protected

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