NIST Biometric Evaluation Framework
Software components for biometric technology evaluations
Public Member Functions | List of all members
BiometricEvaluation::Error::Exception Class Reference

The parent class of all BiometricEvaluation exceptions. More...

#include <be_error_exception.h>

Inherits std::exception.

Inherited by BiometricEvaluation::Error::ConversionError, BiometricEvaluation::Error::DataError, BiometricEvaluation::Error::FileError, BiometricEvaluation::Error::MemoryError, BiometricEvaluation::Error::NotImplemented, BiometricEvaluation::Error::ObjectDoesNotExist, BiometricEvaluation::Error::ObjectExists, BiometricEvaluation::Error::ObjectIsClosed, BiometricEvaluation::Error::ObjectIsOpen, BiometricEvaluation::Error::ParameterError, BiometricEvaluation::Error::StrategyError, and BiometricEvaluation::MPI::Exception.

Public Member Functions

 Exception ()
 Construct an Exception object without an information string. More...
 
 Exception (std::string info)
 Construct an Exception object with an information string. More...
 
virtual ~Exception ()=default
 
const char * what () const noexcept
 Obtain the information string associated with the exception. More...
 
const std::string whatString () const noexcept
 Obtain the information string associated with the exception. More...
 

Detailed Description

The parent class of all BiometricEvaluation exceptions.

The classes derived from this class will have a default information string set indicating the type of exception. Any additional information string is appended to that string.

Definition at line 31 of file be_error_exception.h.

Constructor & Destructor Documentation

◆ Exception() [1/2]

BiometricEvaluation::Error::Exception::Exception ( )

Construct an Exception object without an information string.

◆ Exception() [2/2]

BiometricEvaluation::Error::Exception::Exception ( std::string  info)

Construct an Exception object with an information string.

Parameters
[in]infoThe information string associated with the exception.

◆ ~Exception()

virtual BiometricEvaluation::Error::Exception::~Exception ( )
virtualdefault

Member Function Documentation

◆ what()

const char * BiometricEvaluation::Error::Exception::what ( ) const
noexcept

Obtain the information string associated with the exception.

Returns
The information string as a char array.

◆ whatString()

const std::string BiometricEvaluation::Error::Exception::whatString ( ) const
noexcept

Obtain the information string associated with the exception.

Returns
The information string.

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