This is the base class of common exception classes. More...
#include <CommonException.hpp>
Inheritance diagram for Arp::System::Commons::CommonException:
Public Types | |
| using | ExceptionTypeId = Arp::ExceptionTypeId |
 Public Types inherited from Arp::Base::Core::Exception | |
| using | Ptr = std::unique_ptr< Exception > |
| The smart pointer type of this class. | |
| using | TypeCode = std::underlying_type< Arp::Base::Core::ExceptionTypeId >::type |
| The integral type of the type code. | |
Protected Member Functions | |
| CommonException (ExceptionTypeId typeId, const String &message, int skipStackTraceDepth=0) | |
| Constructs an CommonException instance. | |
| CommonException (ExceptionTypeId typeId, String &&message, int skipStackTraceDepth=0) | |
| Constructs an CommonException instance. | |
| CommonException (ExceptionTypeId typeId, const String &message, const Exception &innerException, int skipStackTraceDepth=0) | |
| Constructs an CommonException instance. | |
| CommonException (ExceptionTypeId typeId, String &&message, Exception &&innerException, int skipStackTraceDepth=0) | |
| Constructs an CommonException instance. | |
| CommonException (ExceptionTypeId typeId, String &&message, Exception::Ptr &&innerExceptionPtr, int skipStackTraceDepth=0) | |
| Constructs an CommonException instance. | |
| CommonException (const CommonException &arg)=default | |
| CommonException (CommonException &&arg) noexcept=default | |
| String | Format (bool withInnerException) const override |
| Formats this exception using the given indent level. More... | |
| Protected Member Functions inherited from Arp::Base::Core::Exception | |
| Exception (ExceptionTypeId typeId, String &&message) | |
| Used by derived exception classes. More... | |
| Exception (ExceptionTypeId typeId, const String &message) | |
| Used by derived exception classes. More... | |
| Exception (ExceptionTypeId typeId, String &&message, const Exception &innerException) | |
| Used by derived exception classes. More... | |
| Exception (ExceptionTypeId typeId, const String &message, const Exception &innerException) | |
| Used by derived exception classes. More... | |
| Exception (String &&message, const Exception::Ptr &innerExceptionPtr) | |
| DEPRECATED. More... | |
| String | Format (int indentLevel, bool withInnerException) const |
| DEPRECATED. More... | |
| virtual uint32 | GetTypeCodeInternal (void) const |
| DEPRECATED. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from Arp::Base::Core::Exception | |
| Exception (const Exception &arg) | |
| Default copy constructor. | |
| Exception (Exception &&arg) noexcept | |
| Default move constructor. | |
| Exception & | operator= (const Exception &arg) |
| Default copy-assignment operator. | |
| Exception & | operator= (Exception &&arg) noexcept |
| Default move-assignment operator. | |
| virtual | ~Exception (void) |
| Default destructor. | |
| Exception (void) | |
| Constructs an empty instance of class Exception. | |
| template<typename... Args> | |
| Exception (const char *message, Args &&... args) | |
| Constructs an instance of class Exception. More... | |
| Exception (const String &message) | |
| Constructs an instance of class Exception. More... | |
| Exception (String &&message) | |
| Constructs an instance of class Exception. More... | |
| Exception (const String &message, const Exception &innerException) | |
| Constructs an instance of class Exception. More... | |
| Exception (String &&message, const Exception &innerException) | |
| Constructs an instance of class Exception. More... | |
| const String & | GetMessage (void) const |
| Gets the error message of this exception. More... | |
| ExceptionTypeId | GetTypeId (void) const |
| Gets the type ID of this exception. More... | |
| TypeCode | GetTypeCode (void) const |
| Gets the type code of this exception. More... | |
| bool | HasInnerException (void) const |
| Determines if this exception has an inner exception. More... | |
| const Exception & | GetInnerException (void) const |
| Gets the inner exception of this exception. More... | |
| String | ToString (void) const |
| This operation should be used for logging and returns a reasonable description of the exception cause. More... | |
| virtual Exception::Ptr | Clone (void) const |
| This operation clones this instance polymorphically as a deep copy. More... | |
| virtual String | Format (bool withInnerException) const |
| Formats this exception using the given indent level. More... | |
| Impl & | GetImpl (void) |
| For internal use only. | |
| const Impl & | GetImpl (void) const |
Detailed Description
This is the base class of common exception classes.
Member Function Documentation
◆ Format()
|
overrideprotectedvirtual |
Formats this exception using the given indent level.
- Parameters
-
withInnerException If truethe inner exception (if any) should be formatted into the resulting string as well.
This operation might be overridden in derived classes to specialize the format when calling ToString.
Reimplemented from Arp::Base::Core::Exception.
The documentation for this class was generated from the following files:
- Arp/System/Commons/Exceptions/CommonException.hpp
- Arp/System/Commons/Exceptions/CommonException.cpp
