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

Manufacture specific command data sent to a PD. More...

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

Public Member Functions

 ManufacturerSpecific (byte[] vendorCode, byte[] data)
 Initializes a new instance of the ManufacturerSpecific 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 ManufacturerSpecific ParseData (ReadOnlySpan< byte > data)
 Parses the message payload bytes.

Properties

byte[] VendorCode [get]
 Gets the vendor code.
byte[] Data [get]
 Gets the manufacture specific data.
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

Manufacture specific command data sent to a PD.

Definition at line 13 of file ManufacturerSpecific.cs.

Constructor & Destructor Documentation

◆ ManufacturerSpecific()

OSDP.Net.Model.CommandData.ManufacturerSpecific.ManufacturerSpecific ( byte[] vendorCode,
byte[] data )
inline

Initializes a new instance of the ManufacturerSpecific class.

Parameters
vendorCodeThe vendor code.
dataThe manufacture specific data.
Exceptions
ArgumentNullExceptionvendorCode
ArgumentNullExceptiondata
ArgumentOutOfRangeExceptionvendorCode

Definition at line 23 of file ManufacturerSpecific.cs.

References Data, and VendorCode.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

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

Definition at line 51 of file ManufacturerSpecific.cs.

References Data, and VendorCode.

◆ ParseData()

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

Parses the message payload bytes.

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

Definition at line 66 of file ManufacturerSpecific.cs.

References ManufacturerSpecific().

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

◆ ToString()

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

Definition at line 75 of file ManufacturerSpecific.cs.

Property Documentation

◆ Code

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

Definition at line 45 of file ManufacturerSpecific.cs.

◆ CommandType

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

Definition at line 42 of file ManufacturerSpecific.cs.

◆ Data

byte [] OSDP.Net.Model.CommandData.ManufacturerSpecific.Data
get

Gets the manufacture specific data.

Definition at line 39 of file ManufacturerSpecific.cs.

Referenced by BuildData(), and ManufacturerSpecific().

◆ VendorCode

byte [] OSDP.Net.Model.CommandData.ManufacturerSpecific.VendorCode
get

Gets the vendor code.

Definition at line 34 of file ManufacturerSpecific.cs.

Referenced by BuildData(), and ManufacturerSpecific().


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