CyberEngineMkIII
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | Public Attributes | Protected Member Functions | List of all members
CYB::Exception::Base Class Reference

The base exception recognized by the entire engine. More...

#include <Exception.hpp>

Inheritance diagram for CYB::Exception::Base:
Inheritance graph
[legend]
Collaboration diagram for CYB::Exception::Base:
Collaboration graph
[legend]

Public Types

enum  Level : byte { Level::VIOLATION, Level::SYSTEM_DATA, Level::INTERNAL, Level::UNIT }
 The extended type of the exception. More...
 

Public Attributes

API::String::Static FMessage
 An english description of the error, guaranteed to be compatible with CYB::API::String::UTF8.
 
const unsigned int FErrorCode
 The assigned error code.
 
const Level FLevel
 The type of the exception.
 

Protected Member Functions

 Base (API::String::Static &&AMessage, const unsigned int AErrorCode, const Level ALevel) noexcept
 Construct a Base exception. More...
 

Detailed Description

The base exception recognized by the entire engine.

Definition at line 7 of file Exception.hpp.

Member Enumeration Documentation

The extended type of the exception.

Enumerator
VIOLATION 

Developer error.

SYSTEM_DATA 

System/Data error.

INTERNAL 

Engine error.

UNIT 

Unit error.

Definition at line 10 of file Exception.hpp.

10  : byte {
11  VIOLATION,
12  SYSTEM_DATA,
13  INTERNAL,
14  UNIT,
15  };
unsigned char byte
It's a byte, 8 bits, etc...
Definition: Types.hpp:4

Constructor & Destructor Documentation

CYB::Exception::Base::Base ( API::String::Static &&  AMessage,
const unsigned int  AErrorCode,
const Level  ALevel 
)
protectednoexcept

Construct a Base exception.

Parameters
AMessageA english description of the error
AErrorCodeThe assigned error code
ALevelThe type of the exception
Thread Safety
This function requires no thread safety

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