OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
Loading...
Searching...
No Matches
OSDP.Net.Model.CommandData.GetPIVData Class Reference

Command data to get the PIV data. More...

Inheritance diagram for OSDP.Net.Model.CommandData.GetPIVData:
OSDP.Net.Model.CommandData.CommandData OSDP.Net.Model.PayloadData

Public Member Functions

 GetPIVData (ObjectId objectId, byte elementId, byte dataOffset)
 Initializes a new instance of the GetPIVData class.
 GetPIVData (byte[] objectId, byte elementId, ushort dataOffset)
 Initializes a new instance of the GetPIVData 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 GetPIVData ParseData (ReadOnlySpan< byte > data)
 Parses the message payload bytes.

Properties

byte[] ObjectId [get]
 Gets the object identifier.
byte ElementId [get]
 Gets the element identifier.
ushort DataOffset [get]
 Gets the data offset.
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 get the PIV data.

Definition at line 12 of file GetPIVData.cs.

Constructor & Destructor Documentation

◆ GetPIVData() [1/2]

OSDP.Net.Model.CommandData.GetPIVData.GetPIVData ( ObjectId objectId,
byte elementId,
byte dataOffset )
inline

Initializes a new instance of the GetPIVData class.

Parameters
objectIdThe object identifier.
elementIdThe element identifier.
dataOffsetThe data offset.

Definition at line 23 of file GetPIVData.cs.

References OSDP.Net.Model.CommandData.CardholderFingerprintTemplate, OSDP.Net.Model.CommandData.CardholderUniqueIdentifier, OSDP.Net.Model.CommandData.CertificateForCardAuthentication, OSDP.Net.Model.CommandData.CertificateForPIVAuthentication, DataOffset, ElementId, and ObjectId.

Referenced by ParseData().

◆ GetPIVData() [2/2]

OSDP.Net.Model.CommandData.GetPIVData.GetPIVData ( byte[] objectId,
byte elementId,
ushort dataOffset )
inline

Initializes a new instance of the GetPIVData class.

Parameters
objectIdThe object identifier with a length of 3.
elementIdThe element identifier.
dataOffsetThe data offset.

Definition at line 46 of file GetPIVData.cs.

References DataOffset, ElementId, and ObjectId.

Member Function Documentation

◆ BuildData()

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

Definition at line 103 of file GetPIVData.cs.

References DataOffset, ElementId, and ObjectId.

◆ ParseData()

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

Parses the message payload bytes.

Parameters
dataMessage payload as bytes
Returns
An instance of GetPIVData representing the message payload

Definition at line 76 of file GetPIVData.cs.

References GetPIVData().

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

◆ ToString()

override string OSDP.Net.Model.CommandData.GetPIVData.ToString ( )
inline

Definition at line 116 of file GetPIVData.cs.

Property Documentation

◆ Code

override byte OSDP.Net.Model.CommandData.GetPIVData.Code
get

Definition at line 97 of file GetPIVData.cs.

◆ CommandType

override CommandType OSDP.Net.Model.CommandData.GetPIVData.CommandType
get

Definition at line 94 of file GetPIVData.cs.

◆ DataOffset

ushort OSDP.Net.Model.CommandData.GetPIVData.DataOffset
get

Gets the data offset.

Definition at line 71 of file GetPIVData.cs.

Referenced by BuildData(), GetPIVData(), and GetPIVData().

◆ ElementId

byte OSDP.Net.Model.CommandData.GetPIVData.ElementId
get

Gets the element identifier.

Definition at line 66 of file GetPIVData.cs.

Referenced by BuildData(), GetPIVData(), and GetPIVData().

◆ ObjectId

byte [] OSDP.Net.Model.CommandData.GetPIVData.ObjectId
get

Gets the object identifier.

Definition at line 61 of file GetPIVData.cs.

Referenced by BuildData(), GetPIVData(), and GetPIVData().


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