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

Represents a command data type for generating an ID report request. More...

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

Public Member Functions

 IdReport ()
 Creates a new instance of IdReport requesting the standard PD ID block.
 IdReport (bool requestExtended)
 Creates a new instance of IdReport.
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.

Properties

bool RequestExtended [get]
 Gets a value indicating whether this request is for the extended ID response.
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

Represents a command data type for generating an ID report request.

Definition at line 10 of file IdReport.cs.

Constructor & Destructor Documentation

◆ IdReport() [1/2]

OSDP.Net.Model.CommandData.IdReport.IdReport ( )
inline

Creates a new instance of IdReport requesting the standard PD ID block.

Definition at line 15 of file IdReport.cs.

◆ IdReport() [2/2]

OSDP.Net.Model.CommandData.IdReport.IdReport ( bool requestExtended)
inline

Creates a new instance of IdReport.

Parameters
requestExtendedIf true, requests the extended PD ID block (osdp_EXT_PDID reply). If false, requests the standard PD ID block (osdp_PDID reply).

Definition at line 26 of file IdReport.cs.

References RequestExtended.

Member Function Documentation

◆ BuildData()

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

Definition at line 46 of file IdReport.cs.

References RequestExtended.

Property Documentation

◆ Code

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

Definition at line 40 of file IdReport.cs.

◆ CommandType

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

Definition at line 37 of file IdReport.cs.

◆ RequestExtended

bool OSDP.Net.Model.CommandData.IdReport.RequestExtended
get

Gets a value indicating whether this request is for the extended ID response.

Definition at line 34 of file IdReport.cs.

Referenced by BuildData(), and IdReport().


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