A Baud Rate Change command (Command ID 0x02) from the Line Quality Test Procedure, section 3.5. More...

Inheritance diagram for OSDP.Net.LineQuality.BaudRateChange:

Public Member Functions
	BaudRateChange (byte sequenceNumber, LineQualityBaudRate baudRateId)
	Initializes a Baud Rate Change command.
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 BaudRateChange command)
	Attempts to parse a Baud Rate Change command from an osdp_MFG payload.

Static Public Attributes
const int	PayloadLength = 6
	Number of payload bytes in a baud rate change command.

Properties
byte	SequenceNumber `[get]`
	Gets the test sequence number.
LineQualityBaudRate	BaudRateId `[get]`
	Gets the requested baud rate identifier.
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

A Baud Rate Change command (Command ID 0x02) from the Line Quality Test Procedure, section 3.5.

The responder acknowledges at the current rate and both ends then switch.

Definition at line 12 of file BaudRateChange.cs.

Constructor & Destructor Documentation

◆ BaudRateChange()

OSDP.Net.LineQuality.BaudRateChange.BaudRateChange	(	byte	sequenceNumber,
		LineQualityBaudRate	baudRateId )

inline

Initializes a Baud Rate Change command.

Parameters

sequenceNumber	Test sequence number, echoed back by the responder.
baudRateId	The rate to switch to.

Definition at line 22 of file BaudRateChange.cs.

References BaudRateId, and SequenceNumber.

Referenced by TryParse().

Member Function Documentation

◆ BuildData()

override byte[] OSDP.Net.LineQuality.BaudRateChange.BuildData ( )

inline

Definition at line 44 of file BaudRateChange.cs.

References OSDP.Net.LineQuality.LineQualityProtocol.BaudRateChangeCommandId, BaudRateId, PayloadLength, and SequenceNumber.

◆ TryParse()

bool OSDP.Net.LineQuality.BaudRateChange.TryParse	(	ReadOnlySpan< byte >	payload,
		out BaudRateChange	command )

inlinestatic

Attempts to parse a Baud Rate Change command from an osdp_MFG payload.

Parameters

payload	The message payload, starting at the vendor code.
command	On success, the parsed command.

Returns: true when the payload is a line quality baud rate change command.

Definition at line 60 of file BaudRateChange.cs.

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

Member Data Documentation

◆ PayloadLength

const int OSDP.Net.LineQuality.BaudRateChange.PayloadLength = 6

static

Number of payload bytes in a baud rate change command.

Definition at line 15 of file BaudRateChange.cs.

Referenced by BuildData(), and TryParse().

Property Documentation

◆ BaudRateId

LineQualityBaudRate OSDP.Net.LineQuality.BaudRateChange.BaudRateId

get

Gets the requested baud rate identifier.

Definition at line 32 of file BaudRateChange.cs.

Referenced by BaudRateChange(), and BuildData().

◆ Code

override byte OSDP.Net.LineQuality.BaudRateChange.Code

get

Definition at line 38 of file BaudRateChange.cs.

◆ CommandType

override CommandType OSDP.Net.LineQuality.BaudRateChange.CommandType

get

Definition at line 35 of file BaudRateChange.cs.

◆ SequenceNumber

byte OSDP.Net.LineQuality.BaudRateChange.SequenceNumber

get

Gets the test sequence number.

Definition at line 29 of file BaudRateChange.cs.