ImageException Class Reference

Exception for image processing. More...

#include <ImageException.h>

Collaboration diagram for ImageException:

Public Types
enum	Reason : uint8_t { UNKNOWN_IMAGE , DECODE_IMAGE , ENCODE_IMAGE , PROCESS_IMAGE }
	Contains all possible reasons of image exception. More...

Public Member Functions
Reason	GetReason () const
	ImageException reason.
	ImageException (Reason r, SourceLocation loc=SourceLocation())
	Constructor creates exception with given reason and information about source location.
	ImageException (Reason r, std::string d, SourceLocation loc=SourceLocation())
	Constructor creates exception with given reason and more specific message.
	EnrollmentException (std::string reason, SourceLocation location=SourceLocation())
	Construct EnrollmentException object.
const char *	what () const noexcept override
	Provides error message.
SourceLocation	Location () const noexcept
	Provides location of error.
std::string	ToString () const
	Provides message with full info about exception.

Detailed Description

Exception for image processing.

Member Enumeration Documentation

Reason

enum Reason : uint8_t

Contains all possible reasons of image exception.

Enumerator
UNKNOWN_IMAGE	Image type is not supported. For supported image types See also ImageType
DECODE_IMAGE	Image type is supported but image format is corrupted.
ENCODE_IMAGE	Problem encode image to given format.
PROCESS_IMAGE	Problem to process an image.

Constructor & Destructor Documentation

ImageException() [1/2]

ImageException ( Reason r, SourceLocation loc = SourceLocation() )

inlineexplicit

Constructor creates exception with given reason and information about source location.

Parameters

r	Reason of exception
loc	(optional) Source location of where the exception was thrown, providing file name, function name, and line information. Defaults to a default-constructed SourceLocation instance if not provided.

ImageException() [2/2]

ImageException ( Reason r, std::string d, SourceLocation loc = SourceLocation() )

inline

Constructor creates exception with given reason and more specific message.

Parameters

r	Reason of exception
d	Description
loc	Source location

Member Function Documentation

EnrollmentException()

EnrollmentException ( std::string reason, SourceLocation location = SourceLocation() )

inlineexplicitinherited

Construct EnrollmentException object.

Constructor of EnrollmentException exception. This exception is used for general errors or as a base class for custom exceptions of the enrollment SDK.

Parameters

reason	error reason
location	Source location of where the exception was thrown

GetReason()

Reason GetReason ( ) const

inlinenodiscard

ImageException reason.

Returns

exception reason

Location()

SourceLocation Location ( ) const

inlinenodiscardnoexceptinherited

Provides location of error.

Returns

error location

ToString()

std::string ToString ( ) const

inlinenodiscardinherited

Provides message with full info about exception.

Returns

exception data as string

what()

const char * what ( ) const

inlinenodiscardoverridenoexceptinherited

Provides error message.

Standard exception error message interface which is usually used for printing message when exception is caught in user application.

Returns

error message

---

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

• Image/ImageException.h