BiometricsBasic Class

Definition

Namespace:

Microsoft.PointOfService.BasicServiceObjects

Assembly:

Microsoft.PointOfService.ControlBase.dll

public abstract class BiometricsBasic : Microsoft.PointOfService.Biometrics, IDisposable

type BiometricsBasic = class
    inherit Biometrics
    interface IDisposable

Public MustInherit Class BiometricsBasic
Inherits Biometrics
Implements IDisposable

Inheritance

Object

PosDevice

PosCommon

Biometrics

BiometricsBasic

Implements

IDisposable

Constructors

BiometricsBasic()

Fields

DataEventEnroll	Indicates the status of enrollment for captured biometrics data. (Inherited from Biometrics)
DataEventVerify	Indicates the status of data verification for captured biometrics data. (Inherited from Biometrics)
ExtendedErrorFirmwareBadFile	Indicates the specified firmware file or files exist, but one or more of those files are either not in the correct format or are corrupted. (Inherited from PosCommon)
ExtendedErrorStatistics	Indicates a specified statistic could not be reset or updated. (Inherited from PosCommon)
ExtendedErrorStatisticsDependency	(Inherited from PosCommon)
StatisticAverageFalseAcceptRate	Indicates the average false acceptance rate. (Inherited from Biometrics)
StatisticAverageFalseRejectRate	Indicates the average false rejection rate. (Inherited from Biometrics)
StatisticCommunicationErrorCount	Holds the programmatic name of the Communication Error Count common statistic. (Inherited from PosCommon)
StatisticDeviceCategory	Holds the programmatic name of the Device Category common statistic. (Inherited from PosCommon)
StatisticFirmwareRevision	Holds the programmatic name of the Firmware Revision common statistic. (Inherited from PosCommon)
StatisticHoursPoweredCount	Holds the programmatic name of the Hours Powered On common statistic. (Inherited from PosCommon)
StatisticInstallationDate	Holds the programmatic name of the Installation Date common statistic. (Inherited from PosCommon)
StatisticInterface	Holds the programmatic name of the Interface common statistic. (Inherited from PosCommon)
StatisticManufactureDate	Holds the programmatic name of the Manufacture Date common statistic. (Inherited from PosCommon)
StatisticManufacturerName	Holds the programmatic name of the Manufacturer Name common statistic. (Inherited from PosCommon)
StatisticMechanicalRevision	Holds the programmatic name of the Mechanical Revision common statistic. (Inherited from PosCommon)
StatisticModelName	Holds the programmatic name of the Model Name common statistic. (Inherited from PosCommon)
StatisticSerialNumber	Holds the programmatic name of the Serial Number common statistic. (Inherited from PosCommon)
StatisticSuccessfulMatchCount	Increments the number when a match is completed successfully. (Inherited from Biometrics)
StatisticUnifiedPOSVersion	Holds the programmatic name of the Unified POS Version common statistic. (Inherited from PosCommon)
StatisticUnsuccessfulMatchCount	Increments the number when a match is completed unsuccessfully. (Inherited from Biometrics)
StatusMoveAway	Indicates that the position was too close. (Inherited from Biometrics)
StatusMoveBackward	Indicates that the position was too far forward. (Inherited from Biometrics)
StatusMoveCloser	Indicates that the position was too far away. (Inherited from Biometrics)
StatusMoveDown	Indicates that the position was too high. (Inherited from Biometrics)
StatusMoveFaster	Indicates that the motion was too slow. (Inherited from Biometrics)
StatusMoveForward	Indicates that the position was too far backward. (Inherited from Biometrics)
StatusMoveLeft	Indicates that the position was too far to the right. (Inherited from Biometrics)
StatusMoveRight	Indicates that the position was too far to the left. (Inherited from Biometrics)
StatusMoveSlower	Indicates that the motion was too fast. (Inherited from Biometrics)
StatusMoveUp	Indicates that the position was too low. (Inherited from Biometrics)
StatusPowerOff	Indicates that the device’s power is turned off or it is detached from the terminal. (Inherited from PosCommon)
StatusPowerOffline	Indicates that the device is powered on but is either not ready or unable to respond to requests. (Inherited from PosCommon)
StatusPowerOffOffline	Indicates that either the device’s power is off or it is offline. (Inherited from PosCommon)
StatusPowerOnline	Indicates that the device’s power is turned on and it is ready for use. (Inherited from PosCommon)
StatusRawData	Indicates that raw image data is available. (Inherited from Biometrics)
StatusSensorComplete	Indicates that the sensor scan is complete. (Inherited from Biometrics)
StatusSensorDirty	Indicates that the sensor is dirty. (Inherited from Biometrics)
StatusSensorFailedRead	Indicates that the sensor failed to capture data. (Inherited from Biometrics)
StatusSensorReady	Indicates that the sensor is ready to scan. (Inherited from Biometrics)
StatusUnspecifiedReadFailure	(Inherited from Biometrics)
StatusUpdateFirmwareComplete	Indicates the update firmware process has completed successfully. (Inherited from PosCommon)
StatusUpdateFirmwareCompleteDeviceNotRestored	Indicates the update firmware process succeeded. However, the Service Object and/or the physical device cannot be returned to the state they were in before the update firmware process started. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceNeedsFirmware	Indicates the update firmware process failed. The device will not be operational until another attempt to update the firmware is successful. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceOk	Indicates the update firmware process failed. However, the device is still operational. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceUnknown	Indicates the update firmware process failed. The device is in an indeterminate state. (Inherited from PosCommon)
StatusUpdateFirmwareFailedDeviceUnrecoverable	Indicates the update firmware process failed. The device is either unusable or unrecoverable through software. (Inherited from PosCommon)
StatusUpdateFirmwareProgress	Indicates the update firmware process has completed 1 to 100 percent successfully. (Inherited from PosCommon)
UseDefault	(Inherited from Biometrics)
WaitForever	Used as the value for a timeout parameter in common and device-specific methods to indicate the method should wait until it receives a response, instead of timing out. (Inherited from PosCommon)

Properties

Algorithm	(Inherited from Biometrics)
AlgorithmList	(Inherited from Biometrics)
AutoDisable
BiometricsInformationRecord	(Inherited from Biometrics)
CapCompareFirmwareVersion
CapPowerReporting
CapPrematchData	(Inherited from Biometrics)
CapRawSensorData	(Inherited from Biometrics)
CapRealTimeData	(Inherited from Biometrics)
CapSensorColor	(Inherited from Biometrics)
CapSensorOrientation	(Inherited from Biometrics)
CapSensorType	(Inherited from Biometrics)
CapStatisticsReporting
CapTemplateAdaptation	(Inherited from Biometrics)
CapUpdateFirmware
CapUpdateStatistics
CheckHealthText	Gets a string that indicates the health of the device. (Inherited from PosCommon)
Claimed
CommonProperties
Compatibility	(Inherited from PosDevice)
DataCount
DataEventEnabled
DeviceDescription
DeviceEnabled
DeviceInstanceId	(Inherited from PosCommon)
DeviceName
DevicePath	Gets or sets the hardware path of a device. (Inherited from PosCommon)
ErrorCount
ExternallyClaimed
FreezeEvents
HardwareId	(Inherited from PosCommon)
IsExclusiveUseDevice	Gets a Boolean value that indicates whether Biometrics is an exclusive-use device. (Inherited from Biometrics)
PowerNotify
PowerState
RawSensorData	(Inherited from Biometrics)
RealTimeDataEnabled	(Inherited from Biometrics)
SensorColor	(Inherited from Biometrics)
SensorOrientation	(Inherited from Biometrics)
SensorType	(Inherited from Biometrics)
ServiceObjectDescription
ServiceObjectVersion
State
SynchronizingObject	Gets or sets the object that is used to marshal the event handler calls issued because of a POS event. (Inherited from PosCommon)

Methods

BeginEnrollCapture(BiometricsInformationRecord, Byte[])	Begins capturing biometrics data for enrollment. (Inherited from Biometrics)
BeginVerifyCapture()	Begins capturing biometrics data for verification. (Inherited from Biometrics)
CheckHealth(HealthCheckLevel)	Tests the state of a device. (Inherited from PosCommon)
Claim(Int32)
ClearInput()
ClearInputImpl()
ClearInputProperties()	Resets the values of properties altered by DataEvent or ErrorEvent. (Inherited from Biometrics)
Close()
CompareFirmwareVersion(String)	Determines whether the version of the specified firmware is newer than, older than, or the same as the version of firmware in the physical device. (Inherited from PosCommon)
CreateStatistic(String, Boolean, String)
CreateStatistic(String, Boolean)
DeleteConfigurationProperty(String)	Deletes the specified property from the XML configuration file. (Inherited from PosCommon)
DirectIO(Int32, Int32, Object)	Used to communicate directly with the Service Object. (Inherited from PosCommon)
Dispose()
Dispose(Boolean)
EndCapture()	Ends the capturing of biometrics data. (Inherited from Biometrics)
GetConfigurationProperty(String)	Used by the Service Object to retrieve the specified property from the XML configuration file. (Inherited from PosCommon)
GetStatisticValue(String)
Identify(Int32, Int32, Boolean, IEnumerable<BiometricsInformationRecord>, Int32)	Captures biometrics data, compares it to an array of BiometricsInformationRecords, and then returns a rank ordered array of indexes. (Inherited from Biometrics)
IdentifyMatch(Int32, Int32, Boolean, BiometricsInformationRecord, IEnumerable<BiometricsInformationRecord>)	Compares a sample Biometrics Information Record against the entries of a collection of other Biometrics Information Records, and then returns a rank ordered array of indexes. (Inherited from Biometrics)
IncrementStatistic(String, Int32)
IncrementStatistic(String)
Invoke(Delegate, Object[])	Used by the Service Objects to raise an event. (Inherited from PosCommon)
Open()
PreFireEvent(DataEventArgs)
PreFireEvent(DeviceErrorEventArgs)
PreFireEvent(DirectIOEventArgs)
PreFireEvent(StatusUpdateEventArgs)
ProcessPrematchData(BiometricsInformationRecord, BiometricsInformationRecord)	Creates biometric samples for use by Match-On-Card and enabled Match-On-Card implementations that require prematch data before matching operations. (Inherited from Biometrics)
QueueEvent(DataEventArgs)
QueueEvent(DeviceErrorEventArgs)
QueueEvent(DirectIOEventArgs)
QueueEvent(StatusUpdateEventArgs)
QueueEventAndWait(DeviceErrorEventArgs)
QueueEventAndWait(DirectIOEventArgs)
Release()
ResetStatistic(String)
ResetStatistics()
ResetStatistics(StatisticCategories)
ResetStatistics(String[])
RetrieveStatistic(String)
RetrieveStatistics()
RetrieveStatistics(StatisticCategories)
RetrieveStatistics(String[])
SetConfigurationProperty(String, String)	Sets a property value (or create a new property) in the XML configuration file. (Inherited from PosCommon)
SetStatisticHandlers(String, GetStatistic, SetStatistic)
SetStatisticValue(String, Object)
UpdateFirmware(String)	Updates the firmware of a device with the version of the firmware contained or defined in the file specified by the firmwareFileName parameter regardless of whether that firmware’s version is newer than, older than, or the same as the version of the firmware already in the device. (Inherited from PosCommon)
UpdateStatistic(String, Object)
UpdateStatistics(Statistic[])
UpdateStatistics(StatisticCategories, Object)
Verify(Int32, Int32, Boolean, BiometricsInformationRecord, Boolean, Int32)	Captures biometrics data and compares it against a designated Biometrics Information Record. (Inherited from Biometrics)
VerifyMatch(Int32, Int32, Boolean, BiometricsInformationRecord, BiometricsInformationRecord, Boolean)	Indicates the event type for DataEvent events. (Inherited from Biometrics)
VerifyState(Boolean, Boolean)

Events

DataEvent
DeviceAddedEvent	(Inherited from PosCommon)
DeviceRemovedEvent	(Inherited from PosCommon)
DirectIOEvent
ErrorEvent
StateChangedEvent
StatusUpdateEvent