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

Command data to control the color of LEDs. More...

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

Public Member Functions

 ReaderLedControls (IEnumerable< ReaderLedControl > controls)
 Initializes a new instance of the ReaderLedControls 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 ReaderLedControls ParseData (ReadOnlySpan< byte > payloadData)
 Parses the message payload bytes.

Properties

IEnumerable< ReaderLedControl > Controls [get]
 One or more commands to control the LEDs of a PD.
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 control the color of LEDs.

Definition at line 13 of file ReaderLedControls.cs.

Constructor & Destructor Documentation

◆ ReaderLedControls()

OSDP.Net.Model.CommandData.ReaderLedControls.ReaderLedControls ( IEnumerable< ReaderLedControl > controls)
inline

Initializes a new instance of the ReaderLedControls class.

Parameters
controlsThe reader LED controls to be updated. It can't be null and requires at least one in the collection.

Definition at line 19 of file ReaderLedControls.cs.

References Controls.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

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

Definition at line 49 of file ReaderLedControls.cs.

References Controls.

◆ ParseData()

ReaderLedControls OSDP.Net.Model.CommandData.ReaderLedControls.ParseData ( ReadOnlySpan< byte > payloadData)
inlinestatic

Parses the message payload bytes.

Parameters
payloadDataMessage payload as bytes
Returns
An instance of ReaderLedControls representing the message payload

Definition at line 63 of file ReaderLedControls.cs.

References OSDP.Net.Model.CommandData.ReaderLedControl.ParseData(), and ReaderLedControls().

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

◆ SecurityControlBlock()

override ReadOnlySpan< byte > OSDP.Net.Model.CommandData.ReaderLedControls.SecurityControlBlock ( )
inline

Definition at line 43 of file ReaderLedControls.cs.

◆ ToString()

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

Definition at line 69 of file ReaderLedControls.cs.

References Controls.

Property Documentation

◆ Code

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

Definition at line 40 of file ReaderLedControls.cs.

◆ CommandType

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

Definition at line 37 of file ReaderLedControls.cs.

◆ Controls

IEnumerable<ReaderLedControl> OSDP.Net.Model.CommandData.ReaderLedControls.Controls
get

One or more commands to control the LEDs of a PD.

Definition at line 34 of file ReaderLedControls.cs.

Referenced by BuildData(), ReaderLedControls(), and ToString().


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