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

The PD device capabilities data sent as a reply. More...

Inheritance diagram for OSDP.Net.Model.ReplyData.DeviceCapabilities:
OSDP.Net.Model.PayloadData

Public Member Functions

 DeviceCapabilities ()
 Creates a new instance of DeviceCapabilities.
 DeviceCapabilities (IEnumerable< DeviceCapability > capabilities)
 Initializes a new instance of DeviceCapabilities class.
override ReadOnlySpan< byte > SecurityControlBlock ()
DeviceCapability Get (CapabilityFunction funcCode)
 Gets a specific PD capability.
T Get< T > (CapabilityFunction funcCode)
override string ToString ()
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.

Properties

IEnumerable< DeviceCapability > Capabilities [get]
 Gets the all the PD's device capabilities.
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

The PD device capabilities data sent as a reply.

Definition at line 13 of file DeviceCapabilities.cs.

Constructor & Destructor Documentation

◆ DeviceCapabilities() [1/2]

OSDP.Net.Model.ReplyData.DeviceCapabilities.DeviceCapabilities ( )
inline

Creates a new instance of DeviceCapabilities.

Definition at line 18 of file DeviceCapabilities.cs.

Referenced by Get< T >().

◆ DeviceCapabilities() [2/2]

OSDP.Net.Model.ReplyData.DeviceCapabilities.DeviceCapabilities ( IEnumerable< DeviceCapability > capabilities)
inline

Initializes a new instance of DeviceCapabilities class.

Parameters
capabilitiesList of DeviceCapability instances

Definition at line 26 of file DeviceCapabilities.cs.

References Capabilities.

Member Function Documentation

◆ BuildData()

override byte[] OSDP.Net.Model.ReplyData.DeviceCapabilities.BuildData ( )
inline

Definition at line 100 of file DeviceCapabilities.cs.

References Capabilities.

◆ Get()

DeviceCapability OSDP.Net.Model.ReplyData.DeviceCapabilities.Get ( CapabilityFunction funcCode)

Gets a specific PD capability.

Parameters
funcCodeFunction code of the capability to get
Returns
Either a DeviceCapability instance or null if one wasn't found for a given function code.

References Capabilities.

◆ Get< T >()

T OSDP.Net.Model.ReplyData.DeviceCapabilities.Get< T > ( CapabilityFunction funcCode)

Strongly timed version of the more generic Get method

Type Constraints
T :DeviceCapability 

References Capabilities, and DeviceCapabilities().

◆ SecurityControlBlock()

override ReadOnlySpan< byte > OSDP.Net.Model.ReplyData.DeviceCapabilities.SecurityControlBlock ( )
inline

Definition at line 40 of file DeviceCapabilities.cs.

◆ ToString()

override string OSDP.Net.Model.ReplyData.DeviceCapabilities.ToString ( )
inline

Definition at line 88 of file DeviceCapabilities.cs.

References Capabilities.

Property Documentation

◆ Capabilities

IEnumerable<DeviceCapability> OSDP.Net.Model.ReplyData.DeviceCapabilities.Capabilities
get

Gets the all the PD's device capabilities.

Definition at line 34 of file DeviceCapabilities.cs.

Referenced by BuildData(), DeviceCapabilities(), Get(), Get< T >(), and ToString().

◆ Code

override byte OSDP.Net.Model.ReplyData.DeviceCapabilities.Code
get

Definition at line 37 of file DeviceCapabilities.cs.


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