This class implements the Screen Manager. More...

Detailed Description

This class implements the Screen Manager.

The screen manager is responsible for navigation mechanics and handling of the Splash, Shutting-Down, and Error-Halt screens

The Screen Manager is required to execute in the UI thread

#include <Api.h>

Inheritance diagram for Ajax::ScreenMgr::Api:

[legend]

Collaboration diagram for Ajax::ScreenMgr::Api:

[legend]

Classes
class	NavigationElement
	Type for 'elements' in the Navigation Stack. More...

Public Member Functions
	Api (Cpl::Dm::MailboxServer &uiMbox, MpScreenApiPtr &homeScreenMP, MpStaticScreenApiPtr &haltUiMP, Cpl::Dm::Mp::Bool &displaySleepRequestMP, MpStaticScreenApiPtr &shutdownMP, DisplayApi &display, NavigationElement memoryForNavigationStack[], size_t numElementsInNavigtationStackArray, Cpl::Container::RingBufferMP< AjaxScreenMgrEvent_T > &eventRingBuffer)
	Constructor.

void	request (OpenMsg &msg)
	Starts/initializes the manager.

void	request (CloseMsg &msg)
	Shutdowns the manager.

void	push (ScreenApi &newScreen) noexcept
	See Ajax::ScreenMgr::Navigation.

void	pop (unsigned count=1) noexcept
	See Ajax::ScreenMgr::Navigation.

void	popTo (ScreenApi &returnToScreen) noexcept
	See Ajax::ScreenMgr::Navigation.

void	popToHome () noexcept
	See Ajax::ScreenMgr::Navigation.

ScreenApi *	getCurrentScreen () noexcept
	See Ajax::ScreenMgr::Navigation.

bool	isCurrentScreenHaltError () noexcept
	See Ajax::ScreenMgr::Navigation.

Public Member Functions inherited from Cpl::Itc::CloseSync
	CloseSync (PostApi &myMbox) noexcept
	Constructor.

bool	close (void *args=nullptr)
	See CloseSync.

Public Member Functions inherited from Cpl::Itc::OpenSync
	OpenSync (PostApi &myMbox) noexcept
	Constructor.

bool	open (void *args=nullptr)
	See OpenApi.

Public Member Functions inherited from Cpl::Itc::OpenApi
virtual	~OpenApi ()
	Virtual destructor.

Public Member Functions inherited from Cpl::Itc::CloseApi
virtual	~CloseApi ()
	Virtual destructor.

Public Member Functions inherited from Ajax::ScreenMgr::Navigation
virtual	~Navigation ()
	Virtual destructor.

Protected Member Functions
void	homeScreenMp_changed (MpScreenApiPtr &modelPointThatChanged, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	MP Change notification.

void	haltUiMp_changed (MpStaticScreenApiPtr &modelPointThatChanged, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	MP Change notification.

void	sleepRequestMp_changed (Cpl::Dm::Mp::Bool &modelPointThatChanged, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	MP Change notification.

void	shutdownMp_changed (MpStaticScreenApiPtr &modelPointThatChanged, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	MP Change notification.

void	eventQueueCountMp_changed (Cpl::Dm::Mp::Uint32 &modelPointThatChanged, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	MP Change notification.

void	timerExpired (void)
	20Hz timer expired

void	transitionToHaltScreen () noexcept
	Helper method.

Protected Attributes
Cpl::Dm::SubscriberComposer< Api, MpScreenApiPtr >	m_obHomeScreenMP
	Subscriber.

Cpl::Dm::SubscriberComposer< Api, MpStaticScreenApiPtr >	m_obHaltUimMP
	Subscriber.

Cpl::Dm::SubscriberComposer< Api, Cpl::Dm::Mp::Bool >	m_obSleepReqMP
	Subscriber.

Cpl::Dm::SubscriberComposer< Api, MpStaticScreenApiPtr >	m_obShutdownReqMP
	Subscriber.

Cpl::Dm::SubscriberComposer< Api, Cpl::Dm::Mp::Uint32 >	m_obEventQueueCountMP
	Subscriber.

Cpl::System::TimerComposer< Api >	m_timer
	20Hz tick timer

MpScreenApiPtr &	m_mpHomeScreen
	Home screen MP.

MpStaticScreenApiPtr &	m_mpHaltUi
	Halt screen MP.

Cpl::Dm::Mp::Bool &	m_mpDisplaySleepRequest
	Sleep request MP (true:= turn off the display)

MpStaticScreenApiPtr &	m_mpShutdownScreen
	Shutdown request MP.

ScreenApi *	m_homeScreenHdl
	Current Home Screen Handle.

DisplayApi &	m_display
	Handle to the 'display'.

Cpl::Container::RingBufferMP< AjaxScreenMgrEvent_T > &	m_eventQueue
	Thread safe Event queue.

Cpl::Container::DList< NavigationElement >	m_freeStackMemoryList
	Free 'memory' for the navigation stack.

Cpl::Container::DList< NavigationElement >	m_navigationStack
	The Navigation stack.

ScreenApi *	m_curScreenHdl
	Current Screen.

uint32_t	m_timerMarker
	Timer marker of last Tick call.

StaticScreenApi *	m_pendingHaltScr
	Pending transition to the error screen.

bool	m_halted
	The UI is halted (due to an application error)

bool	m_shuttingDown
	Shutdown flag.

bool	m_opened
	My open state.

Protected Attributes inherited from Cpl::Itc::OpenSync
PostApi &	m_mbox
	Mailbox (of the server implementing the ITC request() method.

Additional Inherited Members
Public Types inherited from Cpl::Itc::OpenRequest
typedef Cpl::Itc::SAP< OpenRequest >	SAP
	SAP for this API.

typedef RequestMessage< OpenRequest, OpenPayload >	OpenMsg
	Message Type: Open.

Public Types inherited from Cpl::Itc::CloseRequest
typedef Cpl::Itc::SAP< CloseRequest >	SAP
	SAP for this API.

typedef RequestMessage< CloseRequest, ClosePayload >	CloseMsg
	Message Type: Close.

Constructor & Destructor Documentation

◆ Api()

Ajax::ScreenMgr::Api::Api	(	Cpl::Dm::MailboxServer &	uiMbox,
		MpScreenApiPtr &	homeScreenMP,
		MpStaticScreenApiPtr &	haltUiMP,
		Cpl::Dm::Mp::Bool &	displaySleepRequestMP,
		MpStaticScreenApiPtr &	shutdownMP,
		DisplayApi &	display,
		NavigationElement	memoryForNavigationStack[],
		size_t	numElementsInNavigtationStackArray,
		Cpl::Container::RingBufferMP< AjaxScreenMgrEvent_T > &	eventRingBuffer
	)

Constructor.

THe application is responsible for populating the 'freeMemoryForNavigationStack' with 'NullScreen' instances. The number of elements in the list determines the depth of the navigation stack.

Member Function Documentation

◆ eventQueueCountMp_changed()

void Ajax::ScreenMgr::Api::eventQueueCountMp_changed	(	Cpl::Dm::Mp::Uint32 &	modelPointThatChanged,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

MP Change notification.

◆ getCurrentScreen()

ScreenApi * Ajax::ScreenMgr::Api::getCurrentScreen ( )

virtualnoexcept

See Ajax::ScreenMgr::Navigation.

Implements Ajax::ScreenMgr::Navigation.

◆ haltUiMp_changed()

void Ajax::ScreenMgr::Api::haltUiMp_changed	(	MpStaticScreenApiPtr &	modelPointThatChanged,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

MP Change notification.

◆ homeScreenMp_changed()

void Ajax::ScreenMgr::Api::homeScreenMp_changed	(	MpScreenApiPtr &	modelPointThatChanged,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

MP Change notification.

◆ isCurrentScreenHaltError()

bool Ajax::ScreenMgr::Api::isCurrentScreenHaltError ( )

virtualnoexcept

See Ajax::ScreenMgr::Navigation.

Implements Ajax::ScreenMgr::Navigation.

◆ pop()

void Ajax::ScreenMgr::Api::pop ( unsigned count = 1 )

virtualnoexcept

See Ajax::ScreenMgr::Navigation.

Implements Ajax::ScreenMgr::Navigation.

◆ popTo()

void Ajax::ScreenMgr::Api::popTo ( ScreenApi & returnToScreen )

virtualnoexcept

See Ajax::ScreenMgr::Navigation.

Implements Ajax::ScreenMgr::Navigation.

◆ popToHome()

void Ajax::ScreenMgr::Api::popToHome ( )

virtualnoexcept

See Ajax::ScreenMgr::Navigation.

Implements Ajax::ScreenMgr::Navigation.

◆ push()

void Ajax::ScreenMgr::Api::push ( ScreenApi & newScreen )

virtualnoexcept

See Ajax::ScreenMgr::Navigation.

Implements Ajax::ScreenMgr::Navigation.

◆ request() [1/2]

void Ajax::ScreenMgr::Api::request ( CloseMsg & msg )

virtual

Shutdowns the manager.

Implements Cpl::Itc::CloseRequest.

◆ request() [2/2]

void Ajax::ScreenMgr::Api::request ( OpenMsg & msg )

virtual

Starts/initializes the manager.

The open() must pass a non-null pointer to the splash screen (StaticScreenApi*) as the 'args' parameter.

Implements Cpl::Itc::OpenRequest.

◆ shutdownMp_changed()

void Ajax::ScreenMgr::Api::shutdownMp_changed	(	MpStaticScreenApiPtr &	modelPointThatChanged,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

MP Change notification.

◆ sleepRequestMp_changed()

void Ajax::ScreenMgr::Api::sleepRequestMp_changed	(	Cpl::Dm::Mp::Bool &	modelPointThatChanged,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

MP Change notification.

◆ timerExpired()

void Ajax::ScreenMgr::Api::timerExpired ( void )

protected

20Hz timer expired

◆ transitionToHaltScreen()

void Ajax::ScreenMgr::Api::transitionToHaltScreen ( )

protectednoexcept

Helper method.

Member Data Documentation

◆ m_curScreenHdl

ScreenApi* Ajax::ScreenMgr::Api::m_curScreenHdl

protected

Current Screen.

◆ m_display

DisplayApi& Ajax::ScreenMgr::Api::m_display

protected

Handle to the 'display'.

◆ m_eventQueue

Cpl::Container::RingBufferMP<AjaxScreenMgrEvent_T>& Ajax::ScreenMgr::Api::m_eventQueue

protected

Thread safe Event queue.

◆ m_freeStackMemoryList

Cpl::Container::DList<NavigationElement> Ajax::ScreenMgr::Api::m_freeStackMemoryList

protected

Free 'memory' for the navigation stack.

◆ m_halted

bool Ajax::ScreenMgr::Api::m_halted

protected

The UI is halted (due to an application error)

◆ m_homeScreenHdl

ScreenApi* Ajax::ScreenMgr::Api::m_homeScreenHdl

protected

Current Home Screen Handle.

◆ m_mpDisplaySleepRequest

Cpl::Dm::Mp::Bool& Ajax::ScreenMgr::Api::m_mpDisplaySleepRequest

protected

Sleep request MP (true:= turn off the display)

◆ m_mpHaltUi

MpStaticScreenApiPtr& Ajax::ScreenMgr::Api::m_mpHaltUi

protected

Halt screen MP.

◆ m_mpHomeScreen

MpScreenApiPtr& Ajax::ScreenMgr::Api::m_mpHomeScreen

protected

Home screen MP.

◆ m_mpShutdownScreen

MpStaticScreenApiPtr& Ajax::ScreenMgr::Api::m_mpShutdownScreen

protected

Shutdown request MP.

◆ m_navigationStack

Cpl::Container::DList<NavigationElement> Ajax::ScreenMgr::Api::m_navigationStack

protected

The Navigation stack.

◆ m_obEventQueueCountMP

Cpl::Dm::SubscriberComposer<Api, Cpl::Dm::Mp::Uint32> Ajax::ScreenMgr::Api::m_obEventQueueCountMP

protected

Subscriber.

◆ m_obHaltUimMP

Cpl::Dm::SubscriberComposer<Api, MpStaticScreenApiPtr> Ajax::ScreenMgr::Api::m_obHaltUimMP

protected

Subscriber.

◆ m_obHomeScreenMP

Cpl::Dm::SubscriberComposer<Api, MpScreenApiPtr> Ajax::ScreenMgr::Api::m_obHomeScreenMP

protected

Subscriber.

◆ m_obShutdownReqMP

Cpl::Dm::SubscriberComposer<Api, MpStaticScreenApiPtr> Ajax::ScreenMgr::Api::m_obShutdownReqMP

protected

Subscriber.

◆ m_obSleepReqMP

Cpl::Dm::SubscriberComposer<Api, Cpl::Dm::Mp::Bool> Ajax::ScreenMgr::Api::m_obSleepReqMP

protected

Subscriber.

◆ m_opened

bool Ajax::ScreenMgr::Api::m_opened

protected

My open state.

◆ m_pendingHaltScr

StaticScreenApi* Ajax::ScreenMgr::Api::m_pendingHaltScr

protected

Pending transition to the error screen.

◆ m_shuttingDown

bool Ajax::ScreenMgr::Api::m_shuttingDown

protected

Shutdown flag.

◆ m_timer

Cpl::System::TimerComposer<Api> Ajax::ScreenMgr::Api::m_timer

protected

20Hz tick timer

◆ m_timerMarker

uint32_t Ajax::ScreenMgr::Api::m_timerMarker

protected

Timer marker of last Tick call.

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

Ajax/ScreenMgr/Api.h

Detailed Description

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Api()

Member Function Documentation

◆ eventQueueCountMp_changed()

◆ getCurrentScreen()

◆ haltUiMp_changed()

◆ homeScreenMp_changed()

◆ isCurrentScreenHaltError()

◆ pop()

◆ popTo()

◆ popToHome()

◆ push()

◆ request() [1/2]

◆ request() [2/2]

◆ shutdownMp_changed()

◆ sleepRequestMp_changed()

◆ timerExpired()

◆ transitionToHaltScreen()

Member Data Documentation

◆ m_curScreenHdl

◆ m_display

◆ m_eventQueue

◆ m_freeStackMemoryList

◆ m_halted

◆ m_homeScreenHdl

◆ m_mpDisplaySleepRequest

◆ m_mpHaltUi

◆ m_mpHomeScreen

◆ m_mpShutdownScreen

◆ m_navigationStack

◆ m_obEventQueueCountMP

◆ m_obHaltUimMP

◆ m_obHomeScreenMP

◆ m_obShutdownReqMP

◆ m_obSleepReqMP

◆ m_opened

◆ m_pendingHaltScr

◆ m_shuttingDown

◆ m_timer

◆ m_timerMarker