OSDP.Net.Model.CommandData.ReaderTextOutput Class Reference

Command data for sending text to be shown on a PD. More...

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

Public Member Functions
	ReaderTextOutput (byte readerNumber, TextCommand textCommand, byte temporaryTextTime, byte row, byte column, string text)
	Initializes a new instance of the ReaderTextOutput 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 ReaderTextOutput	ParseData (ReadOnlySpan< byte > data)
	Parses the message payload bytes.

Properties
byte	ReaderNumber [get]
	Gets the reader number starting at 0.
TextCommand	TextCommand [get]
	Gets the text command for displaying.
byte	TemporaryTextTime [get]
	Gets the temporary text time in units of 100ms.
byte	Row [get]
	Gets the row where the first character will be displayed. 0x01 = top row.
byte	Column [get]
	The column where the first character will be displayed 0x01 = leftmost column.
string	Text [get]
	Gets the text to display.
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 for sending text to be shown on a PD.

Definition at line 12 of file ReaderTextOutput.cs.

Constructor & Destructor Documentation

ReaderTextOutput()

OSDP.Net.Model.CommandData.ReaderTextOutput.ReaderTextOutput ( byte readerNumber, TextCommand textCommand, byte temporaryTextTime, byte row, byte column, string text )

inline

Initializes a new instance of the ReaderTextOutput class.

Parameters

readerNumber	The reader number starting at 0.
textCommand	The text command for displaying.
temporaryTextTime	The temporary text time in units of 100ms.
row	The row where the first character will be displayed. 0x01 = top row.
column	The column where the first character will be displayed 0x01 = leftmost column.
text	The text to display.

Definition at line 23 of file ReaderTextOutput.cs.

References Column, ReaderNumber, Row, TemporaryTextTime, Text, and TextCommand.

Referenced by ParseData().

Member Function Documentation

BuildData()

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

inline

Definition at line 81 of file ReaderTextOutput.cs.

References Column, ReaderNumber, Row, TemporaryTextTime, Text, and TextCommand.

ParseData()

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

inlinestatic

Parses the message payload bytes.

Parameters

data	Message payload as bytes

Returns

An instance of ReaderTextOutput representing the message payload

Definition at line 62 of file ReaderTextOutput.cs.

References ReaderTextOutput(), and TextCommand.

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

SecurityControlBlock()

override ReadOnlySpan< byte > OSDP.Net.Model.CommandData.ReaderTextOutput.SecurityControlBlock ( )

inline

Definition at line 75 of file ReaderTextOutput.cs.

ToString()

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

inline

Definition at line 90 of file ReaderTextOutput.cs.

Property Documentation

Code

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

get

Definition at line 72 of file ReaderTextOutput.cs.

Column

byte OSDP.Net.Model.CommandData.ReaderTextOutput.Column

get

The column where the first character will be displayed 0x01 = leftmost column.

Definition at line 52 of file ReaderTextOutput.cs.

Referenced by BuildData(), and ReaderTextOutput().

CommandType

override CommandType OSDP.Net.Model.CommandData.ReaderTextOutput.CommandType

get

Definition at line 69 of file ReaderTextOutput.cs.

ReaderNumber

byte OSDP.Net.Model.CommandData.ReaderTextOutput.ReaderNumber

get

Gets the reader number starting at 0.

Definition at line 36 of file ReaderTextOutput.cs.

Referenced by BuildData(), and ReaderTextOutput().

Row

byte OSDP.Net.Model.CommandData.ReaderTextOutput.Row

get

Gets the row where the first character will be displayed. 0x01 = top row.

Definition at line 49 of file ReaderTextOutput.cs.

Referenced by BuildData(), and ReaderTextOutput().

TemporaryTextTime

byte OSDP.Net.Model.CommandData.ReaderTextOutput.TemporaryTextTime

get

Gets the temporary text time in units of 100ms.

Definition at line 46 of file ReaderTextOutput.cs.

Referenced by BuildData(), and ReaderTextOutput().

Text

string OSDP.Net.Model.CommandData.ReaderTextOutput.Text

get

Gets the text to display.

Definition at line 57 of file ReaderTextOutput.cs.

Referenced by BuildData(), and ReaderTextOutput().

TextCommand

TextCommand OSDP.Net.Model.CommandData.ReaderTextOutput.TextCommand

get

Gets the text command for displaying.

Definition at line 41 of file ReaderTextOutput.cs.

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

---

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

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