This class manages the what color/on-off-state of the RGB LED. More...

Detailed Description

This class manages the what color/on-off-state of the RGB LED.

#include <Api.h>

Inheritance diagram for Ajax::Ui::StatusIndicator::Api:

Collaboration diagram for Ajax::Ui::StatusIndicator::Api:

Public Member Functions
	Api (Cpl::Dm::MailboxServer &myMbox, Driver::LED::RedGreenBlue &statusLED, Ajax::ScreenMgr::Navigation &scrMgr)
	Constructor.

void	request (OpenMsg &msg)
	Starts the component.

void	request (CloseMsg &msg)
	Shutdowns the component.

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 Cpl::System::Timer
	Timer (TimerManager &timingSource)
	Constructor

	Timer ()
	Constructor. Alternate constructor - that defers the assignment of the timing source

virtual void	start (unsigned long timerDurationInMilliseconds) noexcept
	Starts the timer with an initial count down count duration of 'timerDurationInMilliseconds'.

virtual void	stop () noexcept
	Stops the timer.

unsigned long	count () const noexcept
	Returns the current count (in milliseconds)

virtual void	setTimingSource (TimerManager &timingSource) noexcept
	Sets the timing source.

Public Member Functions inherited from Cpl::System::CounterCallback_
virtual	~CounterCallback_ ()
	Virtual Destructor.

Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.

bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Member Functions
void	expired () noexcept
	Software timer expired.

bool	setHaltError (uint32_t now) noexcept
	Helper method that set the actual LED state (return true when the error condition is present)

void	setStatus (uint32_t now) noexcept
	Helper method that set the actual LED state.

Protected Member Functions inherited from Cpl::System::Timer
void	decrement (unsigned long milliseconds=1) noexcept
	See Cpl::System::CounterCallback_.

void	increment (unsigned long milliseconds) noexcept
	See Cpl::System::CounterCallback_.

Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.

	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.

	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Attributes
Driver::LED::RedGreenBlue &	m_ledDriver
	Handle to the RGD LED driver.

Ajax::ScreenMgr::Navigation &	m_scrMgr
	Handle to the screen manager.

uint32_t	m_timeMarker2Hz
	Period time marker.

uint32_t	m_timeMarker1Hz
	Period time marker.

uint32_t	m_timeMarkerQuarterHz
	Period time marker.

unsigned	m_state
	Current indicator state (when NOT in a 'hard-error')

bool	m_2HzOnCycle
	Current 'flash edge'.

bool	m_1HzOnCycle
	Current 'flash edge'.

bool	m_quarterHzOnCycle
	Current 'flash edge'.

bool	m_firstExecution
	Flag for initial execution pass.

bool	m_opened
	open/close state

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

Protected Attributes inherited from Cpl::System::Timer
TimerManager *	m_timingSource
	The timer's tick source.

unsigned long	m_count
	Current count.

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.

Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.

Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.

Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.

void *	m_inListPtr_
	Debug field.

Constructor & Destructor Documentation

◆ Api()

Ajax::Ui::StatusIndicator::Api::Api	(	Cpl::Dm::MailboxServer &	myMbox,
		Driver::LED::RedGreenBlue &	statusLED,
		Ajax::ScreenMgr::Navigation &	scrMgr
	)

Constructor.

Member Function Documentation

◆ expired()

void Ajax::Ui::StatusIndicator::Api::expired ( )

protectedvirtualnoexcept

Software timer expired.

Implements Cpl::System::CounterCallback_.

◆ request() [1/2]

void Ajax::Ui::StatusIndicator::Api::request ( CloseMsg & msg )

virtual

Shutdowns the component.

Implements Cpl::Itc::CloseRequest.

◆ request() [2/2]

void Ajax::Ui::StatusIndicator::Api::request ( OpenMsg & msg )

virtual

Starts the component.

Implements Cpl::Itc::OpenRequest.

◆ setHaltError()

bool Ajax::Ui::StatusIndicator::Api::setHaltError ( uint32_t now )

protectednoexcept

Helper method that set the actual LED state (return true when the error condition is present)

◆ setStatus()

void Ajax::Ui::StatusIndicator::Api::setStatus ( uint32_t now )

protectednoexcept

Helper method that set the actual LED state.

Member Data Documentation

◆ m_1HzOnCycle

bool Ajax::Ui::StatusIndicator::Api::m_1HzOnCycle

protected

Current 'flash edge'.

◆ m_2HzOnCycle

bool Ajax::Ui::StatusIndicator::Api::m_2HzOnCycle

protected

Current 'flash edge'.

◆ m_firstExecution

bool Ajax::Ui::StatusIndicator::Api::m_firstExecution

protected

Flag for initial execution pass.

◆ m_ledDriver

Driver::LED::RedGreenBlue& Ajax::Ui::StatusIndicator::Api::m_ledDriver

protected

Handle to the RGD LED driver.

◆ m_opened

bool Ajax::Ui::StatusIndicator::Api::m_opened

protected

open/close state

◆ m_quarterHzOnCycle

bool Ajax::Ui::StatusIndicator::Api::m_quarterHzOnCycle

protected

Current 'flash edge'.

◆ m_scrMgr

Ajax::ScreenMgr::Navigation& Ajax::Ui::StatusIndicator::Api::m_scrMgr

protected

Handle to the screen manager.

◆ m_state

unsigned Ajax::Ui::StatusIndicator::Api::m_state

protected

Current indicator state (when NOT in a 'hard-error')

◆ m_timeMarker1Hz

uint32_t Ajax::Ui::StatusIndicator::Api::m_timeMarker1Hz

protected

Period time marker.

◆ m_timeMarker2Hz

uint32_t Ajax::Ui::StatusIndicator::Api::m_timeMarker2Hz

protected

Period time marker.

◆ m_timeMarkerQuarterHz

uint32_t Ajax::Ui::StatusIndicator::Api::m_timeMarkerQuarterHz

protected

Period time marker.

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

Ajax/Ui/StatusIndicator/Api.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Api()

Member Function Documentation

◆ expired()

◆ request() [1/2]

◆ request() [2/2]

◆ setHaltError()

◆ setStatus()

Member Data Documentation

◆ m_1HzOnCycle

◆ m_2HzOnCycle

◆ m_firstExecution

◆ m_ledDriver

◆ m_opened

◆ m_quarterHzOnCycle

◆ m_scrMgr

◆ m_state

◆ m_timeMarker1Hz

◆ m_timeMarker2Hz

◆ m_timeMarkerQuarterHz