OSDP.Net.Model.CommandData.ReaderBuzzerControl Class Reference

Command data to control the buzzer on a PD. More...

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

Public Member Functions
	ReaderBuzzerControl (byte readerNumber, ToneCode toneCode, byte onTime, byte offTime, byte count)
	Initializes a new instance of the ReaderBuzzerControl 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 ReaderBuzzerControl	ParseData (ReadOnlySpan< byte > data)
	Parses the message payload bytes.

Properties
byte	ReaderNumber [get]
	Gets the reader number starting at 0.
ToneCode	ToneCode [get]
	Gets the tone code.
byte	OnTime [get]
	Gets the on time in units of 100ms.
byte	OffTime [get]
	Gets the off time in units of 100ms.
byte	Count [get]
	Gets the number of times to repeat the on/off cycle.
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 control the buzzer on a PD.

Definition at line 11 of file ReaderBuzzerControl.cs.

Constructor & Destructor Documentation

ReaderBuzzerControl()

OSDP.Net.Model.CommandData.ReaderBuzzerControl.ReaderBuzzerControl ( byte readerNumber, ToneCode toneCode, byte onTime, byte offTime, byte count )

inline

Initializes a new instance of the ReaderBuzzerControl class.

Parameters

readerNumber	The reader number starting at 0.
toneCode	The tone code.
onTime	The on time in units of 100ms.
offTime	The off time in units of 100ms.
count	The number of times to repeat the on/off cycle.

Definition at line 21 of file ReaderBuzzerControl.cs.

References Count, OffTime, OnTime, ReaderNumber, and ToneCode.

Referenced by ParseData().

Member Function Documentation

BuildData()

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

inline

Definition at line 79 of file ReaderBuzzerControl.cs.

References Count, OffTime, OnTime, ReaderNumber, and ToneCode.

ParseData()

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

inlinestatic

Parses the message payload bytes.

Parameters

data	Message payload as bytes

Returns

An instance of ReaderBuzzerControl representing the message payload

Definition at line 58 of file ReaderBuzzerControl.cs.

References ReaderBuzzerControl(), and ToneCode.

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

ToString()

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

inline

Definition at line 85 of file ReaderBuzzerControl.cs.

Property Documentation

Code

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

get

Definition at line 73 of file ReaderBuzzerControl.cs.

CommandType

override CommandType OSDP.Net.Model.CommandData.ReaderBuzzerControl.CommandType

get

Definition at line 70 of file ReaderBuzzerControl.cs.

Count

byte OSDP.Net.Model.CommandData.ReaderBuzzerControl.Count

get

Gets the number of times to repeat the on/off cycle.

Definition at line 53 of file ReaderBuzzerControl.cs.

Referenced by BuildData(), and ReaderBuzzerControl().

OffTime

byte OSDP.Net.Model.CommandData.ReaderBuzzerControl.OffTime

get

Gets the off time in units of 100ms.

Definition at line 48 of file ReaderBuzzerControl.cs.

Referenced by BuildData(), and ReaderBuzzerControl().

OnTime

byte OSDP.Net.Model.CommandData.ReaderBuzzerControl.OnTime

get

Gets the on time in units of 100ms.

Definition at line 43 of file ReaderBuzzerControl.cs.

Referenced by BuildData(), and ReaderBuzzerControl().

ReaderNumber

byte OSDP.Net.Model.CommandData.ReaderBuzzerControl.ReaderNumber

get

Gets the reader number starting at 0.

Definition at line 33 of file ReaderBuzzerControl.cs.

Referenced by BuildData(), and ReaderBuzzerControl().

ToneCode

ToneCode OSDP.Net.Model.CommandData.ReaderBuzzerControl.ToneCode

get

Gets the tone code.

Definition at line 38 of file ReaderBuzzerControl.cs.

Referenced by BuildData(), ParseData(), and ReaderBuzzerControl().

---

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

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