device::FrontPanelTextDisplay::Scroll Class Reference

Collaboration diagram for device::FrontPanelTextDisplay::Scroll:

Public Member Functions
	Scroll (int vIterations=0, int hIterations=0, int holdDuration=0)
	This function is a parameterised constructor of Scroll class. It initializes the scroll parameters with the specified values. If the values are not passed then it sets the scroll parameters of the instance to 0. More...
int	getVerticalIteration () const
	This API gets the vertical iterations for front panel text display scrolling. More...
int	getHorizontalIteration () const
	This API gets the horizontal iterations for front panel text display scrolling. More...
int	getHoldDuration () const
	This API gets the hold duration for front panel text display scrolling. More...

Private Attributes
int	_vIterations
	Indicates vertical iterations of scrolling for text display.
int	_hIterations
	Indicates horizontal iterations of scrolling for text display.
int	_holdDuragion
	Indicates the hold duration for LED while scrolling.

yes

Definition at line 74 of file frontPanelTextDisplay.hpp.

Constructor & Destructor Documentation

Scroll()

Scroll::Scroll ( int  vIterations = 0, int  hIterations = 0, int  holdDuration = 0  )

inline

This function is a parameterised constructor of Scroll class. It initializes the scroll parameters with the specified values. If the values are not passed then it sets the scroll parameters of the instance to 0.

Parameters

[in]	vIterations	Indicates the vertical iterations for scrolling.
[in]	hIterations	Indicates the horizontal iterations for scrolling.
[in]	holdDuration	Indicates the hold duration of LED while scrolling.

Returns

None

Definition at line 93 of file frontPanelTextDisplay.hpp.

Member Function Documentation

getVerticalIteration()

Scroll::getVerticalIteration ( ) const

inline

This API gets the vertical iterations for front panel text display scrolling.

Returns

_vIterations Indicates the vertical iterations for scrolling

Definition at line 106 of file frontPanelTextDisplay.hpp.

getHorizontalIteration()

Scroll::getHorizontalIteration ( ) const

inline

This API gets the horizontal iterations for front panel text display scrolling.

Returns

_hIterations Indicates the horizontal iterations for scrolling

Definition at line 115 of file frontPanelTextDisplay.hpp.

getHoldDuration()

Scroll::getHoldDuration ( ) const

inline

This API gets the hold duration for front panel text display scrolling.

Returns

_holdDuragion Indicates the hold duration for scrolling

Definition at line 124 of file frontPanelTextDisplay.hpp.

---

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

• components/generic/devicesettings/ds/include/frontPanelTextDisplay.hpp