com.senter.function.openapi.unstable

Class FingerprintA

java.lang.Object

com.senter.function.openapi.unstable.FingerprintA

public class FingerprintA
extends java.lang.Object

 Storage area instruction:
 This module has four storage area, which are used to store temporary fingerprint image,temporary fingerprint characteristics,fingerprint database,record library.
 Temporary fingerprint image,temporary fingerprint characteristics:
    Getting fingerprint image information, you can use collectTemporaryFingerprintGraph(), collected fingerprint image will be stored in  the temporary fingerprint image storage area,
       If need to read temporary fingerprint image, you can use getTemporaryFingerprintGraph() instruction to get this information.
       If need to convert it into fingerprint characteristics template, you can use convertTemporaryFingerprintGraphToTemporaryTemplate(), the generated template will be stored in the temporary fingerprint characteristic template storage area,
       If you want to make the fingerprint characteristics richer,after obtaining temporary fingerprint image of the same finger area again by collectTemporaryFingerprintGraph(), using tryUpdateTemporaryFingerprintTemplateByNewTemporaryFingerprintGraph() to update  the temporary fingerprint characteristics template,after updating characteristic template is stored in fingerprint characteristics template storage area.
       If need to get fingerprint characteristics template, you can  respectively use collectTemporaryFingerprintTemplate(),collectTemporaryFingerprintTemplateBySafeMode(),the latter has characteristic of trying to read fingerprints for many times in the execution cycle.
       If need to read temporary fingerprint image, you can use getTemporaryFingerprintTemplate() instruction to get this information   
       If need to add this characteristic template to fingerprint database, you can use #enrollTemporaryFingprintTemplateIntoTemplateLibrary(UserInfo)
 
 
 Fingerprint database:
   The element is referenced by FingerprintA.FingerprintTemplateAndUserInfo, is made up of FingerprintA.FingerprintTemplate and FingerprintA.UserInfo.
   FingerprintA.FingerprintTemplate template for storage fingerprint, FingerprintA.UserInfo stores corresponding information of this fingerprint template, Such as name, job number, etc.
   Quering the total number of fingerprint database, you can execute by getTotalNumberOfFingerprintTemplatesInTemplateLibrary()
   Reading specified fingerprint template, you can execute by getTotalNumberOfFingerprintTemplatesInTemplateLibrary()
   Deleting specified fingerprint template, you can execute by #removeTemplateFromTemplateLibrary(int)
   Clearing all fingerprint template, you can execute by clearFingerprintTemplateLibrary()  
 
 
 Record library: this storage is mainly used to store some information in the process of using.
     The element is referenced by FingerprintA.Record,each record can store data of 64 bytes.
     Reading specified record, you can execute by readRecordFromTheSpecifiedId(int)
     Writting specified record, you can execute by #writeRecordIntoTheSpecifiedIndexId(Record, int)  
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FingerprintA.FingerprintGraph fingerprint graph
static class	FingerprintA.FingerprintTemplate fingerprint template
static class	FingerprintA.FingerprintTemplateAndUserInfo
static class	FingerprintA.ModuleInfo Deprecated.
static class	FingerprintA.Record
static class	FingerprintA.UserInfo User information is used fordescribing fingerprint template
static class	FingerprintA.UserInfoAndFingerprintTemplateId On behalf of fingerprint template ID and its corresponding user information

Constructor Summary

Constructors

Constructor and Description
FingerprintA()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	clearFingerprintTemplateLibrary() Clear fingerprint database in the chip
java.lang.Boolean	collectTemporaryFingerprintGraph()
FingerprintA.FingerprintTemplate	collectTemporaryFingerprintTemplate()
FingerprintA.FingerprintTemplate	collectTemporaryFingerprintTemplateBySafeMode()
java.lang.Integer	collectTemporaryFingerprintTemplateBySafeModeAndAddItIntoTemplateLibrary(FingerprintA.UserInfo userInfo) This instruction collects fingerprints three times in the excuting,becomes module and stores in the chip Storage location returns in the form of return value
java.lang.Boolean	convertTemporaryFingerprintGraphToTemporaryTemplate()
java.lang.Boolean	deleteFingerprintTemplateFromTemplateLibrary(int index) Delete fingerprint template in the chip
java.lang.Boolean	enrollFingerprintTemplateIntoTemplateLibrary(FingerprintA.FingerprintTemplateAndUserInfo mbInfo, int id) store the fingerprint tmeplate and user info into template library
java.lang.Integer	enrollTemporaryFingerprintTemplateIntoTemplateLibrary(FingerprintA.UserInfo additionalInfo) Store fingerprint template data into the chip
java.lang.Integer	generatesARandomNumber() Ger a random number
FingerprintA.FingerprintTemplateAndUserInfo	getFingerprintTemplateFromTemplateLibrary(int id) get fingerprint template specified by id
static FingerprintA	getInstance()
FingerprintA.ModuleInfo	getModuleInfo() Deprecated.
FingerprintA.FingerprintGraph	getTemporaryFingerprintGraph()
FingerprintA.FingerprintTemplate	getTemporaryFingerprintTemplate()
java.lang.Integer	getTotalNumberOfFingerprintTemplatesInTemplateLibrary() get total number of fingerprint templates in template library
java.lang.Boolean	init()
java.lang.Integer	matchFingerOnSensorWithTheSpecifiedFingerprintTemplate(FingerprintA.FingerprintTemplate template) Compare fingerprint information in the fingerprint plate to existing fingerprint template.
FingerprintA.Record	readRecordFromTheSpecifiedId(int id) read record
java.lang.Boolean	tryUpdateTemporaryFingerprintTemplateByNewTemporaryFingerprintGraph() try update temporary fingerprint template by new temporary fingerprint graph
void	uninit()
FingerprintA.UserInfoAndFingerprintTemplateId	verifyFingerOnSensorWithTemplatesInLibrary() verify finger on senor with template in library
java.lang.Boolean	writeRecordIntoTheSpecifiedId(FingerprintA.Record record, int id) write record

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FingerprintA

public FingerprintA()

Method Detail

getInstance

public static FingerprintA getInstance()

See Also:

init(), uninit(), FingerprintA

init

public java.lang.Boolean init()

Returns:

true successfully ; null:unknown ; false:failed

See Also:

uninit(), FingerprintA

uninit

public void uninit()

See Also:

init(), FingerprintA

collectTemporaryFingerprintTemplate

public FingerprintA.FingerprintTemplate collectTemporaryFingerprintTemplate()

See Also:

FingerprintA

collectTemporaryFingerprintTemplateBySafeMode

public FingerprintA.FingerprintTemplate collectTemporaryFingerprintTemplateBySafeMode()

See Also:

FingerprintA

collectTemporaryFingerprintGraph

public java.lang.Boolean collectTemporaryFingerprintGraph()

Returns:

true successfully ; null:unknown ; false:failed

See Also:

FingerprintA

getTemporaryFingerprintGraph

public FingerprintA.FingerprintGraph getTemporaryFingerprintGraph()

See Also:

FingerprintA

getTemporaryFingerprintTemplate

public FingerprintA.FingerprintTemplate getTemporaryFingerprintTemplate()

See Also:

FingerprintA

convertTemporaryFingerprintGraphToTemporaryTemplate

public java.lang.Boolean convertTemporaryFingerprintGraphToTemporaryTemplate()

Returns:

true successfully ; null:unknown ; false:failed

See Also:

FingerprintA

tryUpdateTemporaryFingerprintTemplateByNewTemporaryFingerprintGraph

public java.lang.Boolean tryUpdateTemporaryFingerprintTemplateByNewTemporaryFingerprintGraph()

try update temporary fingerprint template by new temporary fingerprint graph

Returns:

true successfully ; null:unknown ; false:failed

See Also:

FingerprintA

getModuleInfo

@Deprecated
public FingerprintA.ModuleInfo getModuleInfo()

Deprecated.

is only used for debuging, not offers compatibility after upgrading

generatesARandomNumber

public java.lang.Integer generatesARandomNumber()

Ger a random number

See Also:

FingerprintA

collectTemporaryFingerprintTemplateBySafeModeAndAddItIntoTemplateLibrary

public java.lang.Integer collectTemporaryFingerprintTemplateBySafeModeAndAddItIntoTemplateLibrary(FingerprintA.UserInfo userInfo)

This instruction collects fingerprints three times in the excuting,becomes module and stores in the chip Storage location returns in the form of return value

See Also:

FingerprintA

verifyFingerOnSensorWithTemplatesInLibrary

public FingerprintA.UserInfoAndFingerprintTemplateId verifyFingerOnSensorWithTemplatesInLibrary()

verify finger on senor with template in library

See Also:

FingerprintA

enrollFingerprintTemplateIntoTemplateLibrary

public java.lang.Boolean enrollFingerprintTemplateIntoTemplateLibrary(FingerprintA.FingerprintTemplateAndUserInfo mbInfo,
                                                                      int id)

store the fingerprint tmeplate and user info into template library

Returns:

true successfully ; null:unknown ; false:failed

See Also:

FingerprintA

matchFingerOnSensorWithTheSpecifiedFingerprintTemplate

public java.lang.Integer matchFingerOnSensorWithTheSpecifiedFingerprintTemplate(FingerprintA.FingerprintTemplate template)

Compare fingerprint information in the fingerprint plate to existing fingerprint template.

Parameters:

template - is used for comparing existing fingerprint template 

Returns:

compared similarity scores.

See Also:

FingerprintA

getFingerprintTemplateFromTemplateLibrary

public FingerprintA.FingerprintTemplateAndUserInfo getFingerprintTemplateFromTemplateLibrary(int id)

get fingerprint template specified by id

See Also:

FingerprintA

enrollTemporaryFingerprintTemplateIntoTemplateLibrary

public java.lang.Integer enrollTemporaryFingerprintTemplateIntoTemplateLibrary(FingerprintA.UserInfo additionalInfo)

Store fingerprint template data into the chip

See Also:

FingerprintA

deleteFingerprintTemplateFromTemplateLibrary

public java.lang.Boolean deleteFingerprintTemplateFromTemplateLibrary(int index)

Delete fingerprint template in the chip

Returns:

true successfully ; null:unknown ; false:failed

See Also:

FingerprintA

getTotalNumberOfFingerprintTemplatesInTemplateLibrary

public java.lang.Integer getTotalNumberOfFingerprintTemplatesInTemplateLibrary()

get total number of fingerprint templates in template library

See Also:

FingerprintA

clearFingerprintTemplateLibrary

public java.lang.Boolean clearFingerprintTemplateLibrary()

Clear fingerprint database in the chip

Returns:

true successfully ; null:unknown ; false:failed

See Also:

FingerprintA

writeRecordIntoTheSpecifiedId

public java.lang.Boolean writeRecordIntoTheSpecifiedId(FingerprintA.Record record,
                                                       int id)

write record

Parameters:

id - ∈[0,15]

record - !=null

See Also:

FingerprintA

readRecordFromTheSpecifiedId

public FingerprintA.Record readRecordFromTheSpecifiedId(int id)

read record

Parameters:

id - ∈[0,15]

See Also:

FingerprintA