nfiq2_exception.hpp

Go to the documentation of this file.

/*
 * This file is part of NIST Fingerprint Image Quality (NFIQ) 2. For more
 * information on this project, refer to:
 *   - https://nist.gov/services-resources/software/nfiq2
 *   - https://github.com/usnistgov/NFIQ2
 *
 * This work is in the public domain. For complete licensing details, refer to:
 *   - https://github.com/usnistgov/NFIQ2/blob/master/LICENSE.md
 */
 
#ifndef NFIQ2_EXCEPTION_HPP_
#define NFIQ2_EXCEPTION_HPP_
 
#include <exception>
#include <string>
 
namespace NFIQ2 {
 
enum class ErrorCode {
        UnknownError,
        NotEnoughMemory,
        BadArguments,
        FeatureCalculationError,
        CannotWriteToFile,
        CannotReadFromFile,
        NoDataAvailable,
        CannotDecodeBase64,
        InvalidConfiguration,
        MachineLearningError,
        FJFX_CannotCreateContext,
        FJFX_CannotCreateFeatureSet,
        FJFX_NoFeatureSetCreated,
        InvalidNFIQ2Score,
        InvalidImageSize
};
 
class Exception : public std::exception {
    public:
        Exception(const NFIQ2::ErrorCode errorCode);
 
        Exception(
            const NFIQ2::ErrorCode errorCode, const std::string &errorMessage);
 
        virtual ~Exception() noexcept;
 
        virtual const char *what() const noexcept override;
 
        NFIQ2::ErrorCode getErrorCode() const;
 
        std::string getErrorMessage() const;
 
        static std::string defaultErrorMessage(
            const NFIQ2::ErrorCode errorCode);
 
    private:
        const NFIQ2::ErrorCode errorCode { ErrorCode::UnknownError };
        const std::string errorMessage {};
};
} // namespace NFIQ
 
#endif /* NFIQ2_EXCEPTION_HPP_ */