Ajax::ScreenMgr::ScreenApi Class Reference

This class defines the interface for a 'Screen'. More...

Detailed Description

This class defines the interface for a 'Screen'.

The current elapsed time (since power-up) is passed as argument to all of the calls.

#include <ScreenApi.h>

Inheritance diagram for Ajax::ScreenMgr::ScreenApi:

Public Member Functions
virtual void	enter (Cpl::System::ElapsedTime::Precision_T currentElapsedTime) noexcept=0
	This method is called as part of making the screen the 'active' screen.
virtual void	exit (Cpl::System::ElapsedTime::Precision_T currentElapsedTime) noexcept=0
	This method is called as part of the sequence where the screen instance is no longer the active screen.
virtual void	sleep (Cpl::System::ElapsedTime::Precision_T currentElapsedTime) noexcept=0
	This method is used to inform the active screen that the display has been 'turned off'.
virtual void	wake (Cpl::System::ElapsedTime::Precision_T currentElapsedTime) noexcept=0
	This method is used to inform the active screen that the display is about to be turned back on.
virtual void	dispatch (AjaxScreenMgrEvent_T event, Cpl::System::ElapsedTime::Precision_T currentElapsedTime) noexcept=0
	This method is used to dispatch/forward a UI event to active screen.
virtual bool	tick (Cpl::System::ElapsedTime::Precision_T currentElapsedTime) noexcept=0
	This method is used to notify the active screen that the Screen Managers 20Hz timer has expired (i.e.
virtual bool	refresh (Cpl::System::ElapsedTime::Precision_T currentElapsedTime) noexcept=0
	This method requests the active screen to ensure the its screen contents are up to date.
virtual	~ScreenApi ()
	Virtual destructor.

Constructor & Destructor Documentation

~ScreenApi()

virtual Ajax::ScreenMgr::ScreenApi::~ScreenApi ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

dispatch()

virtual void Ajax::ScreenMgr::ScreenApi::dispatch ( AjaxScreenMgrEvent_T  event, Cpl::System::ElapsedTime::Precision_T  currentElapsedTime  )

pure virtualnoexcept

This method is used to dispatch/forward a UI event to active screen.

Implemented in Ajax::ScreenMgr::MockScreen, Ajax::Ui::About::Screen, Ajax::Ui::EditSetpt::Screen, Ajax::Ui::Home::Screen, Eros::Ui::Home::Screen, and Eros::Ui::LcdTest::Screen.

enter()

virtual void Ajax::ScreenMgr::ScreenApi::enter ( Cpl::System::ElapsedTime::Precision_T  currentElapsedTime )

pure virtualnoexcept

This method is called as part of making the screen the 'active' screen.

Implemented in Ajax::ScreenMgr::MockScreen, Ajax::Ui::About::Screen, Ajax::Ui::EditSetpt::Screen, Ajax::Ui::Home::Screen, Eros::Ui::Home::Screen, and Eros::Ui::LcdTest::Screen.

exit()

virtual void Ajax::ScreenMgr::ScreenApi::exit ( Cpl::System::ElapsedTime::Precision_T  currentElapsedTime )

pure virtualnoexcept

This method is called as part of the sequence where the screen instance is no longer the active screen.

Implemented in Ajax::ScreenMgr::MockScreen, Ajax::Ui::About::Screen, Ajax::Ui::EditSetpt::Screen, Ajax::Ui::Home::Screen, Eros::Ui::Home::Screen, and Eros::Ui::LcdTest::Screen.

refresh()

virtual bool Ajax::ScreenMgr::ScreenApi::refresh ( Cpl::System::ElapsedTime::Precision_T  currentElapsedTime )

pure virtualnoexcept

This method requests the active screen to ensure the its screen contents are up to date.

If the screen contents have not changed since the last time the method was - the method returns false. Returning true forces a physical display update.

Implemented in Ajax::ScreenMgr::MockScreen, Ajax::Ui::About::Screen, Ajax::Ui::EditSetpt::Screen, Ajax::Ui::Home::Screen, Eros::Ui::Home::Screen, and Eros::Ui::LcdTest::Screen.

sleep()

virtual void Ajax::ScreenMgr::ScreenApi::sleep ( Cpl::System::ElapsedTime::Precision_T  currentElapsedTime )

pure virtualnoexcept

This method is used to inform the active screen that the display has been 'turned off'.

When the screen is off - no content is visible to user. The actual state of the display RAM is indeterminate

Implemented in Ajax::ScreenMgr::MockScreen, Ajax::Ui::About::Screen, Ajax::Ui::EditSetpt::Screen, Ajax::Ui::Home::Screen, Eros::Ui::Home::Screen, and Eros::Ui::LcdTest::Screen.

tick()

virtual bool Ajax::ScreenMgr::ScreenApi::tick ( Cpl::System::ElapsedTime::Precision_T  currentElapsedTime )

pure virtualnoexcept

This method is used to notify the active screen that the Screen Managers 20Hz timer has expired (i.e.

called every 50ms)

NOTE: A software timer is used, so the accuracy of the callback frequency is NOT guaranteed

Returning true forces a physical display update.

Implemented in Ajax::ScreenMgr::MockScreen, Ajax::Ui::About::Screen, Ajax::Ui::EditSetpt::Screen, Ajax::Ui::Home::Screen, Eros::Ui::Home::Screen, and Eros::Ui::LcdTest::Screen.

wake()

virtual void Ajax::ScreenMgr::ScreenApi::wake ( Cpl::System::ElapsedTime::Precision_T  currentElapsedTime )

pure virtualnoexcept

This method is used to inform the active screen that the display is about to be turned back on.

The Screen Manager is responsible for triggering a refresh() call if the display RAM needs to be updated.

Implemented in Ajax::ScreenMgr::MockScreen, Ajax::Ui::About::Screen, Ajax::Ui::EditSetpt::Screen, Ajax::Ui::Home::Screen, Eros::Ui::Home::Screen, and Eros::Ui::LcdTest::Screen.

---

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

• Ajax/ScreenMgr/ScreenApi.h