CYB::Exception::Violation Class Reference

Exceptions indicating an API contract violation. Should not be anticipated. More...

#include <Exception.hpp>

Inheritance diagram for CYB::Exception::Violation:

Collaboration diagram for CYB::Exception::Violation:

Public Types
enum	ErrorCode : unsigned int {   INVALID_ENUM, INVALID_INTEROP_CONSTRUCTOR, INVALID_OPERATION, INVALID_PARAMETERS,   NEGATIVE_HEAP_ALLOCATION, UNSUPPORTED_ALLOCATION_AMOUNT }
	The error code of the exception. More...
Public Types inherited from CYB::Exception::Base
enum	Level : byte { Level::VIOLATION, Level::SYSTEM_DATA, Level::INTERNAL, Level::UNIT }
	The extended type of the exception. More...

Public Member Functions
	Violation (const ErrorCode AErrorCode) noexcept
	Construct a Violation exception. More...

Static Private Member Functions
static API::String::Static	ErrorMessage (const ErrorCode AErrorCode) noexcept
	Get the associated message for an exception. More...

Additional Inherited Members
Public Attributes inherited from CYB::Exception::Base
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 inherited from CYB::Exception::Base
	Base (API::String::Static &&AMessage, const unsigned int AErrorCode, const Level ALevel) noexcept
	Construct a Base exception. More...

Detailed Description

Exceptions indicating an API contract violation. Should not be anticipated.

Definition at line 32 of file Exception.hpp.

Member Enumeration Documentation

enum CYB::Exception::Violation::ErrorCode : unsigned int

The error code of the exception.

Enumerator
INVALID_ENUM	An operation was attempted with an invalid enum code.
INVALID_INTEROP_CONSTRUCTOR	A contructor passed to the engine was malformed.
INVALID_OPERATION	Illegal call given prexisting conditions.
INVALID_PARAMETERS	The current arrangment of arguments passed the function is invalid.
NEGATIVE_HEAP_ALLOCATION	An allocation was attempted with a negative size value.
UNSUPPORTED_ALLOCATION_AMOUNT	An allocation was attempted with a size above 2047MB.

Definition at line 35 of file Exception.hpp.

                           : unsigned int {
                INVALID_ENUM, 
                INVALID_INTEROP_CONSTRUCTOR,    
                INVALID_OPERATION,  
                INVALID_PARAMETERS, 
                NEGATIVE_HEAP_ALLOCATION, 
                UNSUPPORTED_ALLOCATION_AMOUNT, 
            };

Constructor & Destructor Documentation

CYB::Exception::Violation::Violation ( const ErrorCode  AErrorCode )

noexcept

Construct a Violation exception.

Parameters

AErrorCode

The ErrorCode describing the exception

Thread Safety

This function requires no thread safety

Exceptions

CYB::Exception::Violation

Error code: CYB::Exception::Violation::INVALID_EXCEPTION_CODE. Thrown if AErrorCode is not recognized by the engine

Attention

This function is for internal use only

Definition at line 36 of file CYBException.cpp.

                                                                    :
    Base(ErrorMessage(AErrorCode), AErrorCode, Level::VIOLATION)
{
    FLastInstantiatedExceptionCode = AErrorCode;
}

Member Function Documentation

CYB::API::String::Static CYB::Exception::Violation::ErrorMessage ( const ErrorCode  AErrorCode )

staticprivatenoexcept

Get the associated message for an exception.

Parameters

AErrorCode

The ErrorCode describing the exception

Returns

A description of the exception indicated by AErrorCode

Thread Safety

This function requires no thread safety

Exceptions

CYB::Exception::Violation

Error code: CYB::Exception::Violation::INVALID_EXCEPTION_CODE. Thrown if AErrorCode is not recognized by the engine

Definition at line 11 of file CYBException.cpp.

                                                                                          {
    API::Assert::LessThanOrEqual(AErrorCode, UNSUPPORTED_ALLOCATION_AMOUNT);
    API::String::Static ErrorMessage;
    switch (AErrorCode) {
    case INVALID_ENUM:
        ErrorMessage = API::String::Static(u8"An operation was attempted with an invalid enum code");
        break;
    case INVALID_INTEROP_CONSTRUCTOR:
        ErrorMessage = API::String::Static(u8"An engine allocation was attempted with a malformed constructor");
        break;
    case INVALID_OPERATION:
        ErrorMessage = API::String::Static(u8"An illegal call was made given prexisting conditions");
        break;
    case INVALID_PARAMETERS:
        ErrorMessage = API::String::Static(u8"The current arrangment of arguments passed the function is invalid");
        break;
    case NEGATIVE_HEAP_ALLOCATION:
        ErrorMessage = API::String::Static(u8"Alloc or Realloc called with a negative size value");
        break;
    case UNSUPPORTED_ALLOCATION_AMOUNT:
        ErrorMessage = API::String::Static(u8"An allocation was attempted with a size greater than 2047MB");
        break;
    }
    return ErrorMessage;
}

---

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

• Engine/API/Types/Exception.hpp
• Engine/Engine/Core/CYBException.cpp