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

A Baud Rate Change Acknowledgment (Reply ID 0x02) from the Line Quality Test Procedure, section 3.7. More...

Inheritance diagram for OSDP.Net.LineQuality.BaudRateChangeAck:
OSDP.Net.Model.PayloadData

Public Member Functions

 BaudRateChangeAck (byte sequenceNumber, BaudRateChangeStatus status)
 Initializes a Baud Rate Change Acknowledgment.
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.

Static Public Member Functions

static bool TryParse (ReadOnlySpan< byte > payload, out BaudRateChangeAck ack)
 Attempts to parse a Baud Rate Change Acknowledgment from an osdp_MFGREP payload.

Static Public Attributes

const int PayloadLength = 6
 Number of payload bytes in a baud rate change acknowledgment.

Properties

byte SequenceNumber [get]
 Gets the echoed test sequence number.
BaudRateChangeStatus Status [get]
 Gets the result status.
override byte Code [get]
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.

Detailed Description

A Baud Rate Change Acknowledgment (Reply ID 0x02) from the Line Quality Test Procedure, section 3.7.

Sent at the current rate, immediately before the responder switches.

Definition at line 12 of file BaudRateChangeAck.cs.

Constructor & Destructor Documentation

◆ BaudRateChangeAck()

OSDP.Net.LineQuality.BaudRateChangeAck.BaudRateChangeAck ( byte sequenceNumber,
BaudRateChangeStatus status )
inline

Initializes a Baud Rate Change Acknowledgment.

Parameters
sequenceNumberThe sequence number from the command.
statusThe result status.

Definition at line 22 of file BaudRateChangeAck.cs.

References SequenceNumber, and Status.

Referenced by TryParse().

Member Function Documentation

◆ BuildData()

override byte[] OSDP.Net.LineQuality.BaudRateChangeAck.BuildData ( )
inline

◆ TryParse()

bool OSDP.Net.LineQuality.BaudRateChangeAck.TryParse ( ReadOnlySpan< byte > payload,
out BaudRateChangeAck ack )
inlinestatic

Attempts to parse a Baud Rate Change Acknowledgment from an osdp_MFGREP payload.

Parameters
payloadThe reply payload, starting at the vendor code.
ackOn success, the parsed acknowledgment.
Returns
true when the payload is a line quality baud rate change acknowledgment.

Definition at line 57 of file BaudRateChangeAck.cs.

References BaudRateChangeAck(), OSDP.Net.LineQuality.LineQualityProtocol.BaudRateChangeCommandId, OSDP.Net.LineQuality.LineQualityProtocol.IsLineQualityVendorCode(), and PayloadLength.

Member Data Documentation

◆ PayloadLength

const int OSDP.Net.LineQuality.BaudRateChangeAck.PayloadLength = 6
static

Number of payload bytes in a baud rate change acknowledgment.

Definition at line 15 of file BaudRateChangeAck.cs.

Referenced by BuildData(), and TryParse().

Property Documentation

◆ Code

override byte OSDP.Net.LineQuality.BaudRateChangeAck.Code
get

Definition at line 35 of file BaudRateChangeAck.cs.

◆ SequenceNumber

byte OSDP.Net.LineQuality.BaudRateChangeAck.SequenceNumber
get

Gets the echoed test sequence number.

Definition at line 29 of file BaudRateChangeAck.cs.

Referenced by BaudRateChangeAck(), and BuildData().

◆ Status

BaudRateChangeStatus OSDP.Net.LineQuality.BaudRateChangeAck.Status
get

Gets the result status.

Definition at line 32 of file BaudRateChangeAck.cs.

Referenced by BaudRateChangeAck(), and BuildData().


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