Evaluation of Latent Friction Ridge Technology
API for participating in NIST's evaluation of latent friction ridge identification algorithms.
Public Types | Public Member Functions | Public Attributes | List of all members
ELFT::ReturnStatus Struct Reference

Information about the result of calling an ELFT API function. More...

#include <elft.h>

Public Types

enum class  Result { Success = 0 , Failure }
 Possible outcomes when performing operations. More...
 

Public Member Functions

 operator bool () const noexcept
 

Public Attributes

Result result {}
 The result of the operation. More...
 
std::optional< std::string > message {}
 Information about the result. More...
 

Detailed Description

Information about the result of calling an ELFT API function.

Definition at line 190 of file elft.h.

Member Enumeration Documentation

◆ Result

enum class ELFT::ReturnStatus::Result
strong

Possible outcomes when performing operations.

Enumerator
Success 

Successfully performed operation.

Failure 

Failed to perform operation.

Definition at line 193 of file elft.h.

Member Function Documentation

◆ operator bool()

ELFT::ReturnStatus::operator bool ( ) const
explicitnoexcept
Returns
true if result is Result::Success, false otherwise.

Definition at line 54 of file libelft.cpp.

Member Data Documentation

◆ result

Result ELFT::ReturnStatus::result {}

The result of the operation.

Definition at line 202 of file elft.h.

◆ message

std::optional<std::string> ELFT::ReturnStatus::message {}

Information about the result.

Must match the regular expression [[:graph:] ]*.

Definition at line 207 of file elft.h.


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