OSDP.Net.Model.CommandData.BiometricReadData Class Reference

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

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

Public Member Functions
	BiometricReadData (byte readerNumber, BiometricType biometricType, BiometricFormat biometricFormatType, byte quality)
	Initializes a new instance of the BiometricReadData class.
override ReadOnlySpan< byte >	SecurityControlBlock ()
override byte[]	BuildData ()
override string	ToString ()
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 BiometricReadData	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	Quality [get]
	Gets the ?
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 match.

Definition at line 11 of file BiometricReadData.cs.

Constructor & Destructor Documentation

BiometricReadData()

OSDP.Net.Model.CommandData.BiometricReadData.BiometricReadData ( byte readerNumber, BiometricType biometricType, BiometricFormat biometricFormatType, byte quality )

inline

Initializes a new instance of the BiometricReadData class.

Parameters

readerNumber	The reader number starting at 0.
biometricType	body part to scan.
biometricFormatType	The format of the attached template.
quality

Definition at line 20 of file BiometricReadData.cs.

References BiometricFormatType, BiometricType, Quality, and ReaderNumber.

Referenced by ParseData().

Member Function Documentation

BuildData()

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

inline

Definition at line 59 of file BiometricReadData.cs.

References BiometricFormatType, BiometricType, Quality, and ReaderNumber.

ParseData()

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

inlinestatic

Parses the message payload bytes.

Parameters

data	Message payload as bytes

Returns

An instance of BiometricReadData representing the message payload

Definition at line 73 of file BiometricReadData.cs.

References BiometricReadData(), and BiometricType.

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

ToString()

override string OSDP.Net.Model.CommandData.BiometricReadData.ToString ( )

inline

Definition at line 83 of file BiometricReadData.cs.

Property Documentation

BiometricFormatType

BiometricFormat OSDP.Net.Model.CommandData.BiometricReadData.BiometricFormatType

get

Gets the format of the attached template.

Definition at line 42 of file BiometricReadData.cs.

Referenced by BiometricReadData(), and BuildData().

BiometricType

BiometricType OSDP.Net.Model.CommandData.BiometricReadData.BiometricType

get

Gets the type/body part to scan.

Definition at line 37 of file BiometricReadData.cs.

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

Code

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

get

Definition at line 53 of file BiometricReadData.cs.

CommandType

override CommandType OSDP.Net.Model.CommandData.BiometricReadData.CommandType

get

Definition at line 50 of file BiometricReadData.cs.

Quality

byte OSDP.Net.Model.CommandData.BiometricReadData.Quality

get

Gets the ?

Definition at line 47 of file BiometricReadData.cs.

Referenced by BiometricReadData(), and BuildData().

ReaderNumber

byte OSDP.Net.Model.CommandData.BiometricReadData.ReaderNumber

get

Gets the reader number starting at 0.

Definition at line 32 of file BiometricReadData.cs.

Referenced by BiometricReadData(), and BuildData().

---

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

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