N2N Namespace Reference

Contains all the structures and functions used by the API. More...

Classes
struct	Candidate
	Object used to report a single candidate in a candidate list. More...
struct	FingerImage
	Fingerprint image and image attributes. More...
class	Interface
	The interface to the implementations. More...
struct	ReturnStatus
	Information about the completion status of a method. More...

Typedefs
using	FingerImage = struct FingerImage
	Convenience type for struct FingerImage. More...
using	Candidate = struct Candidate
	Convenience type for struct Candidate. More...
using	ReturnStatus = struct ReturnStatus
	Convenience definition of struct ReturnStatus. More...

Enumerations
enum	StatusCode {   StatusCode::Success = 0, StatusCode::ImageSizeNotSupported = 1, StatusCode::TemplateTypeNotSupported = 2, StatusCode::FailedToExtract = 3,   StatusCode::FailedToSearch = 4, StatusCode::FailedToParseInput = 5, StatusCode::InsufficientResources = 6, StatusCode::Vendor = 7 }
	The status codes that are returned from a function call. More...
enum	InputType { InputType::Capture, InputType::Latent }
	Classes of imagery that can be provided. More...

Functions
std::ostream &	operator<< (std::ostream &s, const StatusCode &sc)
	Output stream operator for a StatusCode object. More...
std::ostream &	operator<< (std::ostream &s, const ReturnStatus &rs)
	Output stream operator for a ReturnStatus object. More...

Detailed Description

Contains all the structures and functions used by the API.

Typedef Documentation

Candidate

using N2N::Candidate = typedef struct Candidate

Convenience type for struct Candidate.

FingerImage

using N2N::FingerImage = typedef struct FingerImage

Convenience type for struct FingerImage.

ReturnStatus

using N2N::ReturnStatus = typedef struct ReturnStatus

Convenience definition of struct ReturnStatus.

Enumeration Type Documentation

InputType

enum N2N::InputType

strong

Classes of imagery that can be provided.

Enumerator
Capture	Images where the subject was present during collection.
Latent	Images where a subject was not present during collection.

StatusCode

enum N2N::StatusCode

strong

The status codes that are returned from a function call.

Enumerator
Success	Successful completion.
ImageSizeNotSupported	Image size too small or large.
TemplateTypeNotSupported	Unsupported template type.
FailedToExtract	Could not extract template from image.
FailedToSearch	Could not search enrollment set.
FailedToParseInput	Failure to parse data.
InsufficientResources	There are not enough resources to complete the task.
Vendor	Vendor-defined error.

Function Documentation

operator<<() [1/2]

std::ostream& N2N::operator<< ( std::ostream &  s, const StatusCode &  sc  )

inline

Output stream operator for a StatusCode object.

operator<<() [2/2]

std::ostream& N2N::operator<< ( std::ostream &  s, const ReturnStatus &  rs  )

inline

Output stream operator for a ReturnStatus object.