C# Class CyrusBuilt.MonoPi.Components.LcdDisplay.LcdBase

Base class for LCD display abstractions.

Inheritance: ComponentBase, ILcd

Public Methods

Method	Description
Clear ( ) : void	Clears the entire display.
Clear ( Int32 row ) : void	Clears the specified row.
Clear ( Int32 row, Int32 column, Int32 length ) : void	Clear one or more characters starting at the specified row and column.
SendCursorHome ( ) : void	Sends the cursor to the home position which is in the top-left corner of the screen.
SetCursorPosition ( Int32 row ) : void	Positions the cursor at the beginning of the specified row.
SetCursorPosition ( Int32 row, Int32 column ) : void	Positions the cursor at the specified column in the specified row.
Write ( Byte data ) : void	Writes a single byte to the display.
Write ( Char data ) : void	Writes a single character to the display.
Write ( Int32 row, Byte data ) : void	Writes a byte array to the display.
Write ( Int32 row, Char data ) : void	Writes a character array to the display in the specified row.
Write ( Int32 row, Int32 column, Byte data ) : void	Write the specified data to the display.
Write ( Int32 row, Int32 column, Char data ) : void	Write the specified data to the display.
Write ( Int32 row, Int32 column, String data ) : void	Writes text to the display in the specified row.
Write ( Int32 row, Int32 column, String data, Object arguments ) : void	Write the specified data to the display.
Write ( Int32 row, String data ) : void	Writes text to the display in the specified row.
Write ( Int32 row, String data, LcdTextAlignment alignment ) : void	Writes text to the display in the specified row.
Write ( Int32 row, String data, LcdTextAlignment alignment, Object arguments ) : void	Write the specified data to the display.
Write ( Int32 row, String data, Object arguments ) : void	Writes text to the display in the specified row.
Write ( String data ) : void	Write the specified data to the display.
Write ( String data, Object arguments ) : void	Write the specified data to the display.
WriteLine ( Int32 row, String data ) : void	Write the specified data to the display with the text aligned to the left.
WriteLine ( Int32 row, String data, LcdTextAlignment alignment ) : void	Write the specified data to the display.
WriteLine ( Int32 row, String data, LcdTextAlignment alignment, Object args ) : void	Write the specified data to the display.
WriteLine ( Int32 row, String data, Object args ) : void	Write the specified data to the display.

Protected Methods

Method	Description
LcdBase ( ) : System	Initializes a new instance of the CyrusBuilt.MonoPi.Components.LcdDisplay.LcdBase class. This is the default constructor.
ValidateColumnIndex ( Int32 column ) : void	Validates the index of the column.
ValidateCoordinates ( Int32 row, Int32 column ) : void	Validates the coordinates.
ValidateRowIndex ( Int32 row ) : void	Validates the index of the row.

Method Details

Clear() public method

Clears the entire display.

public Clear ( ) : void
return	void

Clear() public method

Clears the specified row.

/// The row index is invalid for the display. ///

public Clear ( Int32 row ) : void
row	System.Int32	/// The number of the row to clear. ///
return	void

Clear() public method

Clear one or more characters starting at the specified row and column.

public Clear ( Int32 row, Int32 column, Int32 length ) : void
row	System.Int32	/// The number of the row to clear the character(s) from. ///
column	System.Int32	/// The column that is the starting position. ///
length	System.Int32	/// The number of characters to clear. ///
return	void

LcdBase() protected method

Initializes a new instance of the CyrusBuilt.MonoPi.Components.LcdDisplay.LcdBase class. This is the default constructor.

protected LcdBase ( ) : System
return	System

SendCursorHome() public method

Sends the cursor to the home position which is in the top-left corner of the screen.

public SendCursorHome ( ) : void
return	void

SetCursorPosition() public method

Positions the cursor at the beginning of the specified row.

/// The row or column index is invalid for the display. ///

public SetCursorPosition ( Int32 row ) : void
row	System.Int32	/// The number of the row to position the cursor in. ///
return	void

SetCursorPosition() public abstract method

Positions the cursor at the specified column in the specified row.

public abstract SetCursorPosition ( Int32 row, Int32 column ) : void
row	System.Int32	/// The number of the row to position the cursor in. ///
column	System.Int32	/// The number of the column in the specified row to position the cursor. ///
return	void

ValidateColumnIndex() protected method

Validates the index of the column.

/// The column index is invalid for the display. ///

protected ValidateColumnIndex ( Int32 column ) : void
column	System.Int32	/// The index of the column to validate. ///
return	void

ValidateCoordinates() protected method

Validates the coordinates.

/// The row or column index is invalid for the display. ///

protected ValidateCoordinates ( Int32 row, Int32 column ) : void
row	System.Int32	/// The index of the row to validate. ///
column	System.Int32	/// The index of the column to validate. ///
return	void

ValidateRowIndex() protected method

Validates the index of the row.

/// The row index is invalid for the display. ///

protected ValidateRowIndex ( Int32 row ) : void
row	System.Int32	/// The index of the row to validate. ///
return	void

Write() public abstract method

Writes a single byte to the display.

public abstract Write ( Byte data ) : void
data	Byte	/// The byte to write. ///
return	void

Write() public method

Writes a single character to the display.

public Write ( Char data ) : void
data	Char	/// The character to write. ///
return	void

Write() public method

Writes a byte array to the display.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, Byte data ) : void
row	System.Int32	/// The row to position the data in. ///
data	Byte	/// The array of bytes to write. ///
return	void

Write() public method

Writes a character array to the display in the specified row.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, Char data ) : void
row	System.Int32	/// The row to position the data in. ///
data	Char	/// The array of characters to write. ///
return	void

Write() public method

Write the specified data to the display.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, Int32 column, Byte data ) : void
row	System.Int32	/// The row to position the data in. ///
column	System.Int32	/// The column within the row to start the write. ///
data	Byte	/// The array of bytes to write. ///
return	void

Write() public method

Write the specified data to the display.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, Int32 column, Char data ) : void
row	Int32	/// The row to position the data in. ///
column	Int32	/// The column within the row to start the write. ///
data	Char	/// The array of characters to write. ///
return	void

Write() public method

Writes text to the display in the specified row.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, Int32 column, String data ) : void
row	Int32	/// The row to write the text in. ///
column	Int32	/// The column position within the row to start the write. ///
data	String	/// The text string to write. ///
return	void

Write() public method

Write the specified data to the display.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, Int32 column, String data, Object arguments ) : void
row	Int32	/// The row to position the data in. ///
column	Int32	/// The column within the row to start the write. ///
data	String	/// The string reperesentation of the data to write. ///
arguments	Object	/// The arguments. ///
return	void

Write() public method

Writes text to the display in the specified row.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, String data ) : void
row	Int32	/// The row to write the text in. ///
data	String	/// The text string to write. ///
return	void

Write() public method

Writes text to the display in the specified row.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, String data, LcdTextAlignment alignment ) : void
row	Int32	/// The row to write the text in. ///
data	String	/// The text string to write. ///
alignment	LcdTextAlignment	/// The text alignment within the row. ///
return	void

Write() public method

Write the specified data to the display.

/// The row or column index is invalid for the display. ///

public Write ( Int32 row, String data, LcdTextAlignment alignment, Object arguments ) : void
row	Int32	/// The row to position the data in. ///
data	String	/// The data to write. ///
alignment	LcdTextAlignment	/// The text alignment within the row. ///
arguments	Object	/// The arguments. ///
return	void

Write() public method

Writes text to the display in the specified row.

public Write ( Int32 row, String data, Object arguments ) : void
row	Int32	/// The row to write the text in. ///
data	String	/// The text string to write. ///
arguments	Object	/// The arguments. ///
return	void

Write() public method

Write the specified data to the display.

/// cannot be null. /// /// An encoder fallback occurred. ///

public Write ( String data ) : void
data	String	/// The string reperesentation of the data to write. ///
return	void

Write() public method

Write the specified data to the display.

public Write ( String data, Object arguments ) : void
data	String	/// The string reperesentation of the data to write. ///
arguments	Object	/// The object representing the arguments. ///
return	void

WriteLine() public method

Write the specified data to the display with the text aligned to the left.

/// The row or column index is invalid for the display. ///

public WriteLine ( Int32 row, String data ) : void
row	Int32	/// The row to position the data in. ///
data	String	/// The string reperesentation of the data to write. ///
return	void

WriteLine() public method

Write the specified data to the display.

/// The row or column index is invalid for the display. ///

public WriteLine ( Int32 row, String data, LcdTextAlignment alignment ) : void
row	Int32	/// The row to position the data in. ///
data	String	/// The string reperesentation of the data to write. ///
alignment	LcdTextAlignment	/// The text alignment. ///
return	void

WriteLine() public method

Write the specified data to the display.

/// The row or column index is invalid for the display. ///

public WriteLine ( Int32 row, String data, LcdTextAlignment alignment, Object args ) : void
row	Int32	/// The row to position the data in. ///
data	String	/// The text to write to the display. ///
alignment	LcdTextAlignment	/// The text alignment within the row. ///
args	Object	/// The arguments. ///
return	void

WriteLine() public method

Write the specified data to the display.

/// The row or column index is invalid for the display. ///

public WriteLine ( Int32 row, String data, Object args ) : void
row	Int32	/// The row to position the data in. ///
data	String	/// The string reperesentation of the data to write. ///
args	Object	/// The arguments. ///
return	void