NFIQ2::Exception Class Reference

Exceptions thrown from NFIQ2 functions. More...

#include <nfiq2_exception.hpp>

Inherits std::exception.

Public Member Functions
	Exception (const NFIQ2::ErrorCode &errorCode)
	Constructor which uses supplied error code and default message. More...
	Exception (const NFIQ2::ErrorCode &errorCode, const std::string &errorMessage)
	Constructor which uses supplied error code and user-defined message. More...
virtual	~Exception () noexcept
	Destructor. More...
virtual const char *	what () const noexcept
	Extracts thrown exception error message string. More...
NFIQ2::ErrorCode	getErrorCode () const
	Obtain the return code of the exception. More...
std::string	getErrorMessage () const
	Obtain the error message of the exception. More...

Detailed Description

Exceptions thrown from NFIQ2 functions.

Definition at line 55 of file nfiq2_exception.hpp.

Constructor & Destructor Documentation

Exception() [1/2]

NFIQ2::Exception::Exception

(

const NFIQ2::ErrorCode &

errorCode

)

Constructor which uses supplied error code and default message.

Parameters

errorCode

Error code for thrown exception.

Exception() [2/2]

NFIQ2::Exception::Exception	(	const NFIQ2::ErrorCode &	errorCode,
		const std::string &	errorMessage
	)

Constructor which uses supplied error code and user-defined message.

Parameters

errorCode	Error code for thrown exception.
errorMessage	User defined error message for thrown exception.

~Exception()

virtual NFIQ2::Exception::~Exception ( )

virtualnoexcept

Destructor.

Member Function Documentation

what()

virtual const char* NFIQ2::Exception::what ( ) const

virtualnoexcept

Extracts thrown exception error message string.

Returns

The exception message.

getErrorCode()

NFIQ2::ErrorCode NFIQ2::Exception::getErrorCode

(

)

const

Obtain the return code of the exception.

Returns

The return code.

getErrorMessage()

std::string NFIQ2::Exception::getErrorMessage

(

)

const

Obtain the error message of the exception.

Returns

The error message.

---

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

• nfiq2_exception.hpp