FingerprintTemplate Class Reference

Description

Class encapsulating fingerprint template data plus associated metadata.

This structure is used by FingerprintListener to deliver the results of successful fingerprint template captures to the user.

Thread safety:

• Static functions: safe
• Concurrent accesses to distinct objects: safe
• Concurrent accesses to same object: unsafe, unless all accesses are read-only (i.e. query functions)

Classes
enum	TypeID
	Enumeration of fingerprint template types for capture and enrolment functions. More...

Public Member Functions
	FingerprintTemplate ()
	Default construction - null (empty) Template.
	FingerprintTemplate (@NonNull byte[] initData, @NonNull TypeID initType)
	Construction with given template type and data. More...
byte []	data ()
	Query the contents of the fingerprint template. More...
void	setData (@NonNull byte[] newData)
	Set the contents of the fingerprint template. More...
void	setTemplateType (@NonNull TypeID newType)
	Set the type of template data represented by the object. More...
TypeID	templateType ()
	Query the type of template data represented by the object. More...
String	typeName ()
	Obtain the name of the current template type ID. More...

Static Public Member Functions
static String	typeName (@NonNull TypeID templateType)
	Obtain the name of a given Template type ID. More...

Constructor & Destructor Documentation

FingerprintTemplate()

FingerprintTemplate	(	@NonNull byte []	initData,
		@NonNull TypeID	initType
	)

Construction with given template type and data.

Parameters

initData	Initial value of the template data, passed by copy
initType	Initial value of the template type ID

Member Function Documentation

data()

byte [] data

(

)

Query the contents of the fingerprint template.

Returns

Template contents, represented in the specified format and passed by copy

setData()

void setData

(

@NonNull byte []

newData

)

Set the contents of the fingerprint template.

Parameters

newData

Template contents, represented in the specified format

setTemplateType()

void setTemplateType

(

@NonNull TypeID

newType

)

Set the type of template data represented by the object.

Parameters

newType

New template type in the TypeID format

templateType()

TypeID templateType

(

)

Query the type of template data represented by the object.

Returns

Template type; see TypeID for details

typeName() [1/2]

String typeName

(

)

Obtain the name of the current template type ID.

Returns

String representation of templateType() if known; empty string if unknown

typeName() [2/2]

static String typeName ( @NonNull TypeID  templateType )

static

Obtain the name of a given Template type ID.

Parameters

templateType

The type of Template which is being queried

Returns

String representation of supplied template type if known; empty string if unknown