Device Settings - Front Panel text display APIs

Description

Configuration of individual text display sub-panel to display system time or text is managed here. The scroll speed, time format (12Hour or 24 Hour format) and a string to display can be configured.

Functions
static FrontPanelTextDisplay &	device::FrontPanelTextDisplay::getInstance (int id)
	This API gets the FrontPanelIndicator instance corresponding to the specified id, only if the id passed is valid. More...
	device::FrontPanelTextDisplay::FrontPanelTextDisplay (int id, int maxBrightness, int maxCycleRate, int levels, int maxHorizontalIterations, int maxVerticalIterations, const std::string &supportedCharacters, int colorMode)
void	device::FrontPanelTextDisplay::setText (const std::string &text)
	This API sets the text LED display, by switching the text display to text mode. More...
void	device::FrontPanelTextDisplay::enableDisplay (const int enable)
	This function is used to enable or disable the display of clock on front panel. More...
void	device::FrontPanelTextDisplay::setTextBrightness (const int &brightness)
	This API sets the brightness value for the front panel LED. More...
int	device::FrontPanelTextDisplay::getTextBrightness ()
	This API gets the text LED brightness value. More...
void	device::FrontPanelTextDisplay::getTextBrightnessLevels (int &levels, int &min, int &max)
	This function is used to get maximum brightness, minimum brightness and brightness level of the front panel LED display. More...
int	device::FrontPanelTextDisplay::getTextColorMode ()
	This function is used to get the color mode of the front panel text display. More...
void	device::FrontPanelTextDisplay::setScroll (const Scroll &scroll)
	This API sets the scroll parameters for text LED display like hold duration, vertical iterations and horizontal iterations. More...
int	device::FrontPanelTextDisplay::getCurrentTimeFormat ()
	This API Get the time format of the LED display. More...
void	device::FrontPanelTextDisplay::setTimeFormat (const int iTimeFormat)
	This API sets the time format of the LED display to either 12hr or 24hr format. More...
void	device::FrontPanelTextDisplay::setTime (const int uiHours, const int uiMinutes)
	This API sets the time of the LED display by switching the text display to time mode. More...
void	device::FrontPanelTextDisplay::setMode (int mode)
	This API sets the display mode of the LED display to any, text only or clock only. More...

Function Documentation

getInstance()

FrontPanelTextDisplay & device::FrontPanelTextDisplay::getInstance ( int  id )

static

This API gets the FrontPanelIndicator instance corresponding to the specified id, only if the id passed is valid.

Parameters

[in]

id

Indicates the id of the FrontPanelTextDisplay whose instance has to be returned.

Returns

Returns an instance of FrontPanelTextDisplay corresponding to the id parameter or else throws an IllegalArgumentException indicating that the instance corresponding to the id was not found.

Definition at line 103 of file frontPanelTextDisplay.cpp.

setText()

void device::FrontPanelTextDisplay::setText

(

const std::string &

text

)

This API sets the text LED display, by switching the text display to text mode.

Parameters

[in]

text

Indicates the text to be displayed.

Returns

None

Definition at line 187 of file frontPanelTextDisplay.cpp.

enableDisplay()

void device::FrontPanelTextDisplay::enableDisplay

(

const int

enable

)

This function is used to enable or disable the display of clock on front panel.

Parameters

[in]

enable

Indicates enable or disable value.

Returns

None

Definition at line 204 of file frontPanelTextDisplay.cpp.

setTextBrightness()

void device::FrontPanelTextDisplay::setTextBrightness

(

const int &

brightness

)

This API sets the brightness value for the front panel LED.

Parameters

[in]

brightness

Indicates the brightness value to be set for text LED.

Returns

None

Definition at line 221 of file frontPanelTextDisplay.cpp.

getTextBrightness()

int device::FrontPanelTextDisplay::getTextBrightness

(

)

This API gets the text LED brightness value.

Returns

_TextBrightness Indicates brightness value for text LED.

Definition at line 240 of file frontPanelTextDisplay.cpp.

getTextBrightnessLevels()

void device::FrontPanelTextDisplay::getTextBrightnessLevels	(	int &	levels,
		int &	min,
		int &	max
	)

This function is used to get maximum brightness, minimum brightness and brightness level of the front panel LED display.

• Note:

• Brightness level - Indicates the step value at which the brightness could be changed.

  Parameters

  [out]	max	Indicates maximum brightness for the front panel text display.
  [out]	min	Indicates minimum brightness for the front panel text display.
  [out]	levels	Indicates brightness level of the front panel text display.

  Returns

  None

Definition at line 270 of file frontPanelTextDisplay.cpp.

getTextColorMode()

int device::FrontPanelTextDisplay::getTextColorMode

(

)

This function is used to get the color mode of the front panel text display.

Returns

_colorMode Color mode of the front panel text display is returned.

Definition at line 284 of file frontPanelTextDisplay.cpp.

setScroll()

void device::FrontPanelTextDisplay::setScroll

(

const Scroll &

scroll

)

This API sets the scroll parameters for text LED display like hold duration, vertical iterations and horizontal iterations.

Parameters

[in]

scroll

Contains scroll parameters to be set.

Returns

None

Definition at line 299 of file frontPanelTextDisplay.cpp.

getCurrentTimeFormat()

device::FrontPanelTextDisplay::getCurrentTimeFormat

(

)

This API Get the time format of the LED display.

This API gets the currently set time format for front panel display.

Parameters

[in]

none

Returns

Current Persisted /Set Time Zone format

_timeFormat Indicates the time format

Return values

0	Indicates 12hr format
1	Indicates 24hr format

Definition at line 320 of file frontPanelTextDisplay.cpp.

setTimeFormat()

void device::FrontPanelTextDisplay::setTimeFormat

(

const int

iTimeFormat

)

This API sets the time format of the LED display to either 12hr or 24hr format.

Parameters

[in]

iTimeFormat

Indicates time format. Zero indicates 12hr format. 1 indicates 24hr format.

Returns

None

Definition at line 332 of file frontPanelTextDisplay.cpp.

setTime()

void device::FrontPanelTextDisplay::setTime	(	const int	uiHours,
		const int	uiMinutes
	)

This API sets the time of the LED display by switching the text display to time mode.

Parameters

[in]	uiHours	Indicates hour parameter in time.
[in]	uiMinutes	Indicates minutes parameter in time.

Returns

None

Definition at line 377 of file frontPanelTextDisplay.cpp.

setMode()

device::FrontPanelTextDisplay::setMode

(

int

mode

)

This API sets the display mode of the LED display to any, text only or clock only.

Parameters

[in]

mode

Indicates display mode. 0 indicates both text and clock are supported (default mode). 1 indicates only text mode is supported (trying to set clock results in no change). 2 indicates only clock mode is supported (trying to set text results in no change).

Returns

None

Definition at line 402 of file frontPanelTextDisplay.cpp.