Slap Fingerprint Segmentation Evaluation III
API for participating in NIST's evaluation of slap fingerprint segmentation algorithms.
Public Types | Public Member Functions | Public Attributes | List of all members
SlapSegIII::ReturnStatus Struct Reference

Information about the execution of an API method. More...

#include <slapsegiii.h>

Collaboration diagram for SlapSegIII::ReturnStatus:
Collaboration graph

Public Types

enum class  Code {
  Success = 0 , InvalidImageData , RequestRecapture , RequestRecaptureWithAttempt ,
  UnsupportedResolution , UnsupportedSlapType , NotImplemented , VendorDefined
}
 Possible exit status of a SlapSegIII API method. More...
 

Public Member Functions

 ReturnStatus (const Code code=Code::Success, const std::set< SlapImage::Deficiency > &imageDeficiencies={}, const std::string &message="")
 ReturnStatus constructor. More...
 

Public Attributes

Code code {}
 Returned status code. More...
 
std::set< SlapImage::DeficiencyimageDeficiencies {}
 Deficiencies with a SlapImage (required only when code is RequestRecapture or RequestRecaptureWithAttempt). More...
 
std::string message {}
 Explanatory message (optional). More...
 

Detailed Description

Information about the execution of an API method.

Definition at line 313 of file slapsegiii.h.

Member Enumeration Documentation

◆ Code

enum class SlapSegIII::ReturnStatus::Code
strong

Possible exit status of a SlapSegIII API method.

Enumerator
Success 

Success.

InvalidImageData 

Failure: Image data was not parsable.

RequestRecapture 

Failure: Image cannot be reliably segmented and should be recaptured.

No best-effort segmentation attempt will be provided. At least one Deficiency shall be specified.

RequestRecaptureWithAttempt 

Failure: Image cannot be reliably segmented and should be recaptured.

Best-effort segmentation was attempted. At least one Deficiency shall be specified.

UnsupportedResolution 

Failure: Image resolution not supported.

UnsupportedSlapType 

Failure: Slap type is not supported.

NotImplemented 

Failure: This method is not implemented.

VendorDefined 

Failure: Other reason.

See error message.

Definition at line 316 of file slapsegiii.h.

Constructor & Destructor Documentation

◆ ReturnStatus()

SlapSegIII::ReturnStatus::ReturnStatus ( const Code  code = Code::Success,
const std::set< SlapImage::Deficiency > &  imageDeficiencies = {},
const std::string &  message = "" 
)

ReturnStatus constructor.

Parameters
codeStatus code from a method.
imageDeficienciesIf code is RequestRecapture or RequestRecaptureWithAttempt, one or more Deficiency describing why a recapture should be requested.
messageMessage providing insight into code's value.
Note
If successful, returning from a method can be accomplished by return {};.

Definition at line 94 of file libslapsegiii.cpp.

Member Data Documentation

◆ code

Code SlapSegIII::ReturnStatus::code {}

Returned status code.

Definition at line 370 of file slapsegiii.h.

◆ imageDeficiencies

std::set<SlapImage::Deficiency> SlapSegIII::ReturnStatus::imageDeficiencies {}

Deficiencies with a SlapImage (required only when code is RequestRecapture or RequestRecaptureWithAttempt).

Definition at line 375 of file slapsegiii.h.

◆ message

std::string SlapSegIII::ReturnStatus::message {}

Explanatory message (optional).

Definition at line 377 of file slapsegiii.h.


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