Inheritance diagram for VIB_NET::LCD:

Detailed Description

This class controls the status display of the Machine Vision Controller.

See class VIB::LCD in the VisionBox Interface Library for a detailed description.

Public Types
enum	eAUTO_TYPE
	Definitions for automatic text display, used by ConfigureAutoText() More...

Public Member Functions
void	ClearDisplay ()
	Clears the entire display. More...

void	ConfigureAutoText (const VIB_NET::LCD::eAUTO_TYPE TextType, const bool DisplayText)
	Enables or disables the auto text feature. More...

	LCD ()
	Default constructor for the device object More...

void	Reset ()
	Resets the device to default settings. More...

void	WriteText (const UInt32 StartCharacterIndex, const UInt32 StartLineIndex, const UInt32 CharactersToWrite, array< Byte >^ pText, const bool LineWrap)
	Displays the given text on the display, starting at the give coordinates. More...

Public Member Functions inherited from VIB_NET::iDevice
void	Close ()
	Closes a device More...

bool	isOpen ()
	Returns the open state of a device object More...

void	Open ()
	Opens a device More...

void	Open (unsigned int Index)
	Opens a device More...

Properties
UInt32	NumberOfCharactersPerLine `[get]`
	Holds the number of characters in one line. More...

UInt32	NumberOfLines `[get]`
	Holds the number of lines. More...

virtual VIB_NET::eDEVICE_TYPE	Type `[get]`
	Returns the device type for the current instance, see eDEVICE_TYPE More...

Properties inherited from VIB_NET::iDevice
virtual VIB_NET::eDEVICE_TYPE	Type `[get]`
	Returns the device type for the current instance, see eDEVICE_TYPE More...

Member Enumeration Documentation

◆ eAUTO_TYPE

enum VIB_NET::LCD::eAUTO_TYPE

strong

Definitions for automatic text display, used by ConfigureAutoText()

POST code and temperature modes are only supported by the VisionBox AGE-X4.
If the POST code and temperature are both enabled, they will appear alternately on the second line.

Enumerator
ONTIME	Display time since the last power-on or reset in the first line.
POSTCODE	Display the last BIOS POST code in the second line.
TEMPERATURE	Display the main-board temperature in the second line.

Constructor & Destructor Documentation

◆ LCD()

VIB_NET::LCD::LCD ( )

Default constructor for the device object

The device must be opened with Open() before it can be used.

Member Function Documentation

◆ ClearDisplay()

void VIB_NET::LCD::ClearDisplay ( )

Clears the entire display.

◆ ConfigureAutoText()

void VIB_NET::LCD::ConfigureAutoText	(	const VIB_NET::LCD::eAUTO_TYPE	TextType,
		const bool	DisplayText
	)

Enables or disables the auto text feature.

Parameters

TextType	Auto text type to change
DisplayText	true, enable the auto text

◆ Reset()

void VIB_NET::LCD::Reset ( )

Resets the device to default settings.

◆ WriteText()

void VIB_NET::LCD::WriteText	(	const UInt32	StartCharacterIndex,
		const UInt32	StartLineIndex,
		const UInt32	CharactersToWrite,
		array< Byte >^	pText,
		const bool	LineWrap
	)

Displays the given text on the display, starting at the give coordinates.

Parameters

StartCharacterIndex	First column, 0 ... (NumberOfCharactersPerLine - 1)
StartLineIndex	First line, 0 ... (NumberOfLines - 1)
CharactersToWrite	Number of chars inside pText which are displayed.
pText	ASCII coded string.
LineWrap	false, writes the string only in to the given line, if not enough space the additional characters are discarded.

Property Documentation

◆ NumberOfCharactersPerLine

VIB_NET::LCD::NumberOfCharactersPerLine

get

Holds the number of characters in one line.

◆ NumberOfLines

VIB_NET::LCD::NumberOfLines

get

Holds the number of lines.

◆ Type

VIB_NET::LCD::Type

get

Returns the device type for the current instance, see eDEVICE_TYPE