OSDP.Net.Model.CommandData.CommunicationConfiguration Class Reference

Command data to set the communication configuration on a PD. More...

Inheritance diagram for OSDP.Net.Model.CommandData.CommunicationConfiguration:

Public Member Functions
	CommunicationConfiguration (byte address, int baudRate)
	Initializes a new instance of the CommunicationConfiguration 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 CommunicationConfiguration	ParseData (ReadOnlySpan< byte > data)
	Parses the message payload bytes.

Properties
byte	Address [get]
	Gets the address.
int	BaudRate [get]
	Gets the baud rate.
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 set the communication configuration on a PD.

Definition at line 12 of file CommunicationConfiguration.cs.

Constructor & Destructor Documentation

CommunicationConfiguration()

OSDP.Net.Model.CommandData.CommunicationConfiguration.CommunicationConfiguration ( byte address, int baudRate )

inline

Initializes a new instance of the CommunicationConfiguration class.

Parameters

address	The address.
baudRate	The baud rate.

Definition at line 19 of file CommunicationConfiguration.cs.

References Address, and BaudRate.

Referenced by ParseData().

Member Function Documentation

BuildData()

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

inline

Definition at line 45 of file CommunicationConfiguration.cs.

References Address, and BaudRate.

ParseData()

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

inlinestatic

Parses the message payload bytes.

Parameters

data	Message payload as bytes

Returns

An instance of CommunicationConfiguration representing the message payload

Definition at line 62 of file CommunicationConfiguration.cs.

References CommunicationConfiguration().

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

ToString()

override string OSDP.Net.Model.CommandData.CommunicationConfiguration.ToString ( )

inline

Definition at line 68 of file CommunicationConfiguration.cs.

Property Documentation

Address

byte OSDP.Net.Model.CommandData.CommunicationConfiguration.Address

get

Gets the address.

Definition at line 28 of file CommunicationConfiguration.cs.

Referenced by BuildData(), OSDP.Net.ControlPanel.CommunicationConfiguration(), and CommunicationConfiguration().

BaudRate

int OSDP.Net.Model.CommandData.CommunicationConfiguration.BaudRate

get

Gets the baud rate.

Definition at line 33 of file CommunicationConfiguration.cs.

Referenced by BuildData(), and CommunicationConfiguration().

Code

override byte OSDP.Net.Model.CommandData.CommunicationConfiguration.Code

get

Definition at line 39 of file CommunicationConfiguration.cs.

CommandType

override CommandType OSDP.Net.Model.CommandData.CommunicationConfiguration.CommandType

get

Definition at line 36 of file CommunicationConfiguration.cs.

---

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

• OSDP.Net/Model/CommandData/CommunicationConfiguration.cs