RTC Toolkit  0.1.0-alpha
Public Member Functions | List of all members
elt::error::CiiError Class Reference

Base class for errors. More...

#include <exceptions.hpp>

Inheritance diagram for elt::error::CiiError:
elt::error::CiiException

Public Member Functions

std::string GetSeverity () const
 
 CiiException (const std::string &message)
 Constructor. More...
 
template<typename ... Args>
 CiiException (const std::string &formatter, Args ... args)
 Constructor that takes a formatter string and additional parameters to build the exception message. More...
 
- Public Member Functions inherited from elt::error::CiiException
 CiiException (const std::string &message)
 Constructor. More...
 
template<typename ... Args>
 CiiException (const std::string &formatter, Args ... args)
 Constructor that takes a formatter string and additional parameters to build the exception message. More...
 
virtual ~CiiException ()=default
 Destructor. More...
 
virtual std::string getCiiType () const
 
virtual std::string getCiiMethodName () const
 
virtual std::string getCiiClassName () const
 
virtual std::string getCiiFileName () const
 
virtual std::string getCiiHostName () const
 
virtual std::string getCiiStackTrace () const
 
virtual std::vector< std::string > getCiiExceptionStack () const
 
virtual std::string getCiiMessage () const
 
virtual std::string getCiiDetails () const
 
virtual int64_t getCiiCreationDate () const
 
const std::string GetCiiStackTrace () const noexcept
 
const boost::stacktrace::stacktrace & GetStackTrace () const
 Return the stack trace captured in the exception constructor. More...
 
const boost::stacktrace::stacktrace & GetOriginalStackTrace () const
 Return the stack trace captured in the most nested exception constructor. More...
 
std::string GetStackTraceAsString () const
 Same as GetStackTrace() but convert the trace to a string. More...
 
std::string GetOriginalStackTraceAsString () const
 Same as GetOriginalStackTrace() but convert the trace to a string. More...
 
std::string GetFullStackTraceAsString () const
 Return the full stack trace (including nested exceptions) More...
 
std::chrono::time_point< clock_tGetTimePoint () const
 Return the exception creation time as a chrono timepoint. More...
 
int64_t GetCreationDate () const
 Return the exception creation time as number of seconds since Unix Epoch. More...
 
std::thread::id GetThreadId () const
 Return the id of the thread in which the exception was created. More...
 
int GetProcessId () const
 Return the id of the process in which the exception was created. More...
 
const std::string & GetHostName () const
 Return the name of the host in which the exception was created. More...
 
std::string GetTypeName () const
 Return the exception class name. More...
 
void SetLineNumber (uint32_t lineNumber)
 Set the line number in which the exception was thrown. More...
 
uint32_t GetLineNumber () const
 Return the line number in which the exception was thrown. More...
 
void SetFunctionName (const std::string &functionName)
 Set the name of the function in which the exception was thrown. More...
 
const std::string & GetFunctionName () const
 Return the name of the function in which the exception was thrown. More...
 
void SetFileName (const std::string &fileName)
 Set the name of the file in which the exception was thrown. More...
 
const std::string & GetFileName () const
 Return the name of the file in which the exception was thrown. More...
 
void SetDetails (const std::string &details)
 Set the exception details. More...
 
std::string GetDetails () const
 Get the exception details. More...
 
void SetClassName (const std::string &className)
 Set the name of the class in which the exception was thrown. More...
 
std::string Dump () const
 Return all the exception's details. More...
 
std::string GetSeverity () const
 
std::string DumpWithNested () const
 Return all the exception's details, including details of nested exceptions. More...
 
const char * what () const noexcept override
 
const char * What () const noexcept
 Return all the exception's details, including details of nested exceptions. More...
 
void SetCiiExceptionStack (const std::vector< std::string > &nested_exceptions)
 

Additional Inherited Members

- Public Types inherited from elt::error::CiiException
typedef std::chrono::system_clock clock_t
 The clock to use for determining the exception creation time. More...
 

Detailed Description

Base class for errors.

Member Function Documentation

◆ CiiException() [1/2]

template<typename ... Args>
elt::error::CiiException::CiiException ( typename ...  Args)
inlineexplicit

Constructor that takes a formatter string and additional parameters to build the exception message.

Parameters
formatterthe formatter string, in snprintf format
argsthe arguments for the formatter string

◆ CiiException() [2/2]

elt::error::CiiException::CiiException
explicit

Constructor.

Parameters
messagea message describibng the error

◆ GetSeverity()

std::string elt::error::CiiError::GetSeverity ( ) const
inline

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