CTextLcd allows control of the 16x2 text LCD on the VEXPro. More...

#include <textlcd.h>

Inheritance diagram for CTextLcd:

Public Member Functions
	SINGLETON (CTextLcd)
	This internal macro handles instantiation of this class.
void	Clear ()
	Clear the LCD of all characters.
void	MoveCursor (const unsigned int row, const unsigned int col)
	Move the cursor to the specifed row, column location.
int	printf (const char *format,...)
	print to LCD, printf style.
void	SetCharacter (const char character)
	output a single character.
virtual int	GetProperty (int property, long *value)
	See the definition of IProperty::GetProperty for more information on this method.
virtual int	SetProperty (int property, long value)
	See the definition of IProperty::SetProperty for more information on this method.
Static Public Attributes
static const unsigned int	NUM_ROWS = 2
static const unsigned int	NUM_COLUMNS = 16

Detailed Description

CTextLcd allows control of the 16x2 text LCD on the VEXPro.

To instantiate this class:

 // by pointer
 CTextLcd *plcd = CTextLcd::GetPtr(); 
 // or by reference
 CTextLcd &lcd = CTextLcd::GetRef();

And when done with this class, call Release(), for each call to GetPtr() or GetRef():

 CTextLcd::Release();

Member Function Documentation

void CTextLcd::Clear ( )

Clear the LCD of all characters.

int CTextLcd::GetProperty	(	int	property,
		long *	value
	)			`[virtual]`

See the definition of IProperty::GetProperty for more information on this method.

The following properties are supported:

TL_PROP_BACKLIGHT=the state of the backlight on the LCD, where 0=off, 1=on.

TL_PROP_HEIGHT=the height of the LCD in rows (2 for now).

TL_PROP_WIDTH=the width ofthe LCD in columns (16 for now).

Implements IProperty.

void CTextLcd::MoveCursor	(	const unsigned int	row,
		const unsigned int	col
	)

Move the cursor to the specifed row, column location.

Parameters:

	row	desired row, either 0, or 1 since it is a 2 row text LCD.
	col	desired column, 0 thru 15, since it is a 16 column text LCD.

int CTextLcd::printf	(	const char *	format,
			...
	)

print to LCD, printf style.

Parameters:

format

the format string, same as printf in stdio.h.

Returns:: the number of characters printed

void CTextLcd::SetCharacter ( const char character )

output a single character.

Parameters:

character

character to print.

int CTextLcd::SetProperty	(	int	property,
		long	value
	)			`[virtual]`

See the definition of IProperty::SetProperty for more information on this method.

The following properties re supported:

TL_PROP_BACKLIGHT=set the state of the LCD backlight, where 0=off, 1=on.

Implements IProperty.

CTextLcd::SINGLETON ( CTextLcd )

This internal macro handles instantiation of this class.

Member Data Documentation

const unsigned int CTextLcd::NUM_COLUMNS = 16 [static]

const unsigned int CTextLcd::NUM_ROWS = 2 [static]

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

CTextLcd Class Reference

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation