GrabbaFingerprintTemplate Class Reference

Description

Encapsulation of fingerprint template data plus the associated metadata.

Note

All property values are passed by copy; a new copy of the value will be generated each time a property is read.

Thread safety:

• Concurrent accesses to distinct objects: safe
• Concurrent accesses to the same object: unsafe, unless all accesses are read-only (i.e. property reads)

Inheritance diagram for GrabbaFingerprintTemplate:

Instance Methods
(instancetype _Nullable)	- init
	Initialise a null (empty) fingerprint template. More...
(instancetype _Nullable)	- initWithData:type:
	Initialise a fingerprint template with given data and type. More...

Class Methods
(instancetype _Nullable)	+ templ
	Allocate and initialise a null (empty) fingerprint template. More...
(instancetype _Nullable)	+ templateWithData:type:
	Allocate and initialise a new fingerprint template with given data and type. More...
(NSString *_Nonnull)	+ typeNameForID:
	Obtain the name of a given template type ID. More...

Properties
NSData *_Nonnull	data
	Raw template data, in the specified format. More...
GrabbaFingerprintTemplateTypeID	templateType
	Type of the template data. More...
NSString *_Nonnull	typeName
	Name of the current template type ID. More...

Method Documentation

init()

- (instancetype _Nullable) init

Initialise a null (empty) fingerprint template.

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

initWithData:type:()

- (instancetype _Nullable) initWithData:		(NSData *_Nonnull)	data
type:		(GrabbaFingerprintTemplateTypeID)	type

Initialise a fingerprint template with given data and type.

Parameters

data	Initial value of the data field (template data)
type	Initial value of the type field (template type ID)

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

templ()

+ (instancetype _Nullable) templ

Allocate and initialise a null (empty) fingerprint template.

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

templateWithData:type:()

+ (instancetype _Nullable) templateWithData:		(NSData *_Nonnull)	data
type:		(GrabbaFingerprintTemplateTypeID)	type

Allocate and initialise a new fingerprint template with given data and type.

Parameters

data	Initial value of the data field (template data)
type	Initial value of the type field (template type ID)

Returns

Pointer to initialised object if initialisation succeeded; nil if it failed

typeNameForID:()

+ (NSString* _Nonnull) typeNameForID:

(GrabbaFingerprintTemplateTypeID)

ID

Obtain the name of a given template type ID.

Parameters

ID	The type of template which is being queried

Returns

String representation of given ID if known; empty string if unknown

Property Documentation

data

- (NSData* _Nonnull) data

readwritenonatomiccopy

Raw template data, in the specified format.

templateType

- (GrabbaFingerprintTemplateTypeID) templateType

readwritenonatomicassign

Type of the template data.

typeName

- (NSString* _Nonnull) typeName

readnonatomiccopy

Name of the current template type ID.

This value is not directly writeable; updates should use templateType instead