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

Command data to control the outputs of a PD. More...

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

Public Member Functions

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

Properties

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

Definition at line 13 of file OutputControls.cs.

Constructor & Destructor Documentation

◆ OutputControls()

OSDP.Net.Model.CommandData.OutputControls.OutputControls ( IEnumerable< OutputControl > controls)
inline

Initializes a new instance of the OutputControls class.

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

Definition at line 19 of file OutputControls.cs.

References Controls.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

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

Definition at line 46 of file OutputControls.cs.

References Controls.

◆ ParseData()

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

Parses the message payload bytes.

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

Definition at line 60 of file OutputControls.cs.

References OutputControls(), and OSDP.Net.Model.CommandData.OutputControl.ParseData().

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

◆ ToString()

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

Definition at line 66 of file OutputControls.cs.

References Controls.

Property Documentation

◆ Code

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

Definition at line 43 of file OutputControls.cs.

◆ CommandType

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

Definition at line 37 of file OutputControls.cs.

◆ Controls

IEnumerable<OutputControl> OSDP.Net.Model.CommandData.OutputControls.Controls
get

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

Definition at line 34 of file OutputControls.cs.

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


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