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

Contains data to control a single output on a PD. More...

Public Member Functions

 OutputControl (byte outputNumber, OutputControlCode outputControlCode, ushort timer)
 Initializes a new instance of the OutputControl class.
IEnumerable< byte > BuildData ()
 Builds the payload data array.
override string ToString ()

Static Public Member Functions

static OutputControl ParseData (ReadOnlySpan< byte > data)
 Parses the message payload bytes.

Properties

byte OutputNumber [get]
 Gets the output number.
OutputControlCode OutputControlCode [get]
 Gets the output control code.
ushort Timer [get]
 Gets the timer in units of 100ms.

Detailed Description

Contains data to control a single output on a PD.

Definition at line 11 of file OutputControl.cs.

Constructor & Destructor Documentation

◆ OutputControl()

OSDP.Net.Model.CommandData.OutputControl.OutputControl ( byte outputNumber,
OutputControlCode outputControlCode,
ushort timer )
inline

Initializes a new instance of the OutputControl class.

Parameters
outputNumberThe output number.
outputControlCodeThe output control code.
timerThe timer in units of 100ms.

Definition at line 19 of file OutputControl.cs.

References OutputControlCode, OutputNumber, and Timer.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

IEnumerable< byte > OSDP.Net.Model.CommandData.OutputControl.BuildData ( )
inline

Builds the payload data array.

Returns
The payload data

Definition at line 45 of file OutputControl.cs.

References OutputControlCode, OutputNumber, and Timer.

◆ ParseData()

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

Parses the message payload bytes.

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

Definition at line 55 of file OutputControl.cs.

References OutputControl(), and OutputControlCode.

Referenced by OSDP.Net.Model.CommandData.OutputControls.ParseData().

◆ ToString()

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

Definition at line 63 of file OutputControl.cs.

Property Documentation

◆ OutputControlCode

OutputControlCode OSDP.Net.Model.CommandData.OutputControl.OutputControlCode
get

Gets the output control code.

Definition at line 34 of file OutputControl.cs.

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

◆ OutputNumber

byte OSDP.Net.Model.CommandData.OutputControl.OutputNumber
get

Gets the output number.

Definition at line 29 of file OutputControl.cs.

Referenced by BuildData(), and OutputControl().

◆ Timer

ushort OSDP.Net.Model.CommandData.OutputControl.Timer
get

Gets the timer in units of 100ms.

Definition at line 39 of file OutputControl.cs.

Referenced by BuildData(), and OutputControl().


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