OSDP.Net.Model.CommandData.BiometricTemplateData Class Reference

Command data to send a request to the PD to perform a biometric scan and return data. More...

Inheritance diagram for OSDP.Net.Model.CommandData.BiometricTemplateData:

Public Member Functions
	BiometricTemplateData (byte readerNumber, BiometricType biometricType, BiometricFormat biometricFormatType, byte qualityThreshold, byte[] templateData)
	Initializes a new instance of the BiometricTemplateData class.
override ReadOnlySpan< byte >	SecurityControlBlock ()
override byte[]	BuildData ()
Public Member Functions inherited from OSDP.Net.Model.PayloadData
byte[]	BuildData ()
	Converts the payload into a byte array to be sent over the wire.
ReadOnlySpan< byte >	SecurityControlBlock ()
	Retrieves the security control block for a specific command data type.
virtual void	CustomMessageUpdate (Span< byte > messageBuffer)
	Updates the message data before sending in the specified byte buffer.

Static Public Member Functions
static BiometricTemplateData	ParseData (ReadOnlySpan< byte > data)
	Parses the message payload bytes.

Properties
byte	ReaderNumber [get]
	Gets the reader number starting at 0.
BiometricType	BiometricType [get]
	Gets the type/body part to scan.
BiometricFormat	BiometricFormatType [get]
	Gets the format of the attached template.
byte	QualityThreshold [get]
	Gets the threshold required for accepting biometric match.
byte[]	TemplateData [get]
	Gets the biometric template data.
override CommandType	CommandType [get]
override byte	Code [get]
Properties inherited from OSDP.Net.Model.CommandData.CommandData
CommandType	CommandType [get]
	Message command code.
Properties inherited from OSDP.Net.Model.PayloadData
byte	Code [get]
	Gets the command or reply code byte value that represent the type of data.
virtual bool	IsSecurityInitialization [get]
	Gets a value indicating whether the security initialization is performed by this payload.

Additional Inherited Members
Static Protected Member Functions inherited from OSDP.Net.Model.CommandData.CommandData
static T[]	SplitData< T > (int size, Func< byte[], T > parseDataFunction, ReadOnlySpan< byte > payloadData)
	Splits data into multiple elements of type T based on a specified size.

Detailed Description

Command data to send a request to the PD to perform a biometric scan and return data.

Definition at line 11 of file BiometricTemplateData.cs.

Constructor & Destructor Documentation

BiometricTemplateData()

OSDP.Net.Model.CommandData.BiometricTemplateData.BiometricTemplateData ( byte readerNumber, BiometricType biometricType, BiometricFormat biometricFormatType, byte qualityThreshold, byte[] templateData )

inline

Initializes a new instance of the BiometricTemplateData class.

Parameters

readerNumber	The reader number starting at 0.
biometricType	The type/body part to scan.
biometricFormatType	The format of the attached template.
qualityThreshold	The threshold required for accepting biometric match.
templateData	The biometric template data.

Definition at line 21 of file BiometricTemplateData.cs.

References BiometricFormatType, BiometricType, QualityThreshold, ReaderNumber, and TemplateData.

Referenced by ParseData().

Member Function Documentation

BuildData()

override byte[] OSDP.Net.Model.CommandData.BiometricTemplateData.BuildData ( )

inline

Definition at line 66 of file BiometricTemplateData.cs.

References BiometricFormatType, BiometricType, QualityThreshold, ReaderNumber, and TemplateData.

ParseData()

BiometricTemplateData OSDP.Net.Model.CommandData.BiometricTemplateData.ParseData ( ReadOnlySpan< byte > data )

inlinestatic

Parses the message payload bytes.

Parameters

data	Message payload as bytes

Returns

An instance of BiometricTemplateData representing the message payload

Definition at line 83 of file BiometricTemplateData.cs.

References BiometricTemplateData(), and BiometricType.

Referenced by OSDP.Net.Device.EnqueuePollReply(), and OSDP.Net.Model.Packet.ParsePayloadData().

Property Documentation

BiometricFormatType

BiometricFormat OSDP.Net.Model.CommandData.BiometricTemplateData.BiometricFormatType

get

Gets the format of the attached template.

Definition at line 44 of file BiometricTemplateData.cs.

Referenced by BiometricTemplateData(), and BuildData().

BiometricType

BiometricType OSDP.Net.Model.CommandData.BiometricTemplateData.BiometricType

get

Gets the type/body part to scan.

Definition at line 39 of file BiometricTemplateData.cs.

Referenced by BiometricTemplateData(), BuildData(), and ParseData().

Code

override byte OSDP.Net.Model.CommandData.BiometricTemplateData.Code

get

Definition at line 60 of file BiometricTemplateData.cs.

CommandType

override CommandType OSDP.Net.Model.CommandData.BiometricTemplateData.CommandType

get

Definition at line 57 of file BiometricTemplateData.cs.

QualityThreshold

byte OSDP.Net.Model.CommandData.BiometricTemplateData.QualityThreshold

get

Gets the threshold required for accepting biometric match.

Definition at line 49 of file BiometricTemplateData.cs.

Referenced by BiometricTemplateData(), and BuildData().

ReaderNumber

byte OSDP.Net.Model.CommandData.BiometricTemplateData.ReaderNumber

get

Gets the reader number starting at 0.

Definition at line 34 of file BiometricTemplateData.cs.

Referenced by BiometricTemplateData(), and BuildData().

TemplateData

byte [] OSDP.Net.Model.CommandData.BiometricTemplateData.TemplateData

get

Gets the biometric template data.

Definition at line 54 of file BiometricTemplateData.cs.

Referenced by BiometricTemplateData(), and BuildData().

---

The documentation for this class was generated from the following file:

• OSDP.Net/Model/CommandData/BiometricTemplateData.cs