This class manages the collection of Metrics and triggering their updates to persistent storage. More...

Detailed Description

This class manages the collection of Metrics and triggering their updates to persistent storage.

#include <Api.h>

Inheritance diagram for Ajax::Metrics::Api:

Collaboration diagram for Ajax::Metrics::Api:

Public Member Functions
	Api (Cpl::Dm::MailboxServer &myMbox)
	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 time expired.

void	fanPWMChanged (Cpl::Dm::Mp::Uint32 &mpPWM, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Change notification.

void	heaterPWMChanged (Cpl::Dm::Mp::Uint32 &mpPWM, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Change notification.

void	failsafeAlertChanged (Ajax::Dm::MpAlert &mpAlert, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Change notification.

void	processFanMetric (uint32_t currentElapsedTimeMs, uint32_t pwm, uint32_t intervalTime=OPTION_AJAX_METRICS_INTERVAL_TIME_MS) noexcept
	Helper method to increment metric mp.

void	processHeaterMetric (uint32_t currentElapsedTimeMs, uint32_t pwm, uint32_t intervalTime=OPTION_AJAX_METRICS_INTERVAL_TIME_MS) noexcept
	Helper method to increment metric mp.

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
Cpl::Dm::SubscriberComposer< Api, Cpl::Dm::Mp::Uint32 >	m_obFanPWM
	Observer for change notifications.

Cpl::Dm::SubscriberComposer< Api, Cpl::Dm::Mp::Uint32 >	m_obHeaterPWM
	Observer for change notifications.

Cpl::Dm::SubscriberComposer< Api, Ajax::Dm::MpAlert >	m_obFailsafeAlert
	Observer for change notifications.

uint32_t	m_runtimeMarker
	Time marker of when last updated the metrics to persistent storage.

uint32_t	m_heaterMarker
	Time marker of when last updated the metrics to persistent storage.

uint32_t	m_fanMarker
	Time marker of when last updated the metrics to persistent storage.

bool	m_fanOn
	Current on/off state.

bool	m_heaterOn
	Current on/off state.

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::Metrics::Api::Api ( Cpl::Dm::MailboxServer & myMbox )

Constructor.

Member Function Documentation

◆ expired()

void Ajax::Metrics::Api::expired ( )

protectedvirtualnoexcept

Software time expired.

Implements Cpl::System::CounterCallback_.

◆ failsafeAlertChanged()

void Ajax::Metrics::Api::failsafeAlertChanged	(	Ajax::Dm::MpAlert &	mpAlert,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

Change notification.

◆ fanPWMChanged()

void Ajax::Metrics::Api::fanPWMChanged	(	Cpl::Dm::Mp::Uint32 &	mpPWM,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

Change notification.

◆ heaterPWMChanged()

void Ajax::Metrics::Api::heaterPWMChanged	(	Cpl::Dm::Mp::Uint32 &	mpPWM,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

Change notification.

◆ processFanMetric()

void Ajax::Metrics::Api::processFanMetric	(	uint32_t	currentElapsedTimeMs,
		uint32_t	pwm,
		uint32_t	intervalTime = `OPTION_AJAX_METRICS_INTERVAL_TIME_MS`
	)

protectednoexcept

Helper method to increment metric mp.

◆ processHeaterMetric()

void Ajax::Metrics::Api::processHeaterMetric	(	uint32_t	currentElapsedTimeMs,
		uint32_t	pwm,
		uint32_t	intervalTime = `OPTION_AJAX_METRICS_INTERVAL_TIME_MS`
	)

protectednoexcept

Helper method to increment metric mp.

◆ request() [1/2]

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

virtual

Shutdowns the component.

Implements Cpl::Itc::CloseRequest.

◆ request() [2/2]

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

virtual

Starts the component.

Implements Cpl::Itc::OpenRequest.

Member Data Documentation

◆ m_fanMarker

uint32_t Ajax::Metrics::Api::m_fanMarker

protected

Time marker of when last updated the metrics to persistent storage.

◆ m_fanOn

bool Ajax::Metrics::Api::m_fanOn

protected

Current on/off state.

◆ m_heaterMarker

uint32_t Ajax::Metrics::Api::m_heaterMarker

protected

Time marker of when last updated the metrics to persistent storage.

◆ m_heaterOn

bool Ajax::Metrics::Api::m_heaterOn

protected

Current on/off state.

◆ m_obFailsafeAlert

Cpl::Dm::SubscriberComposer<Api, Ajax::Dm::MpAlert> Ajax::Metrics::Api::m_obFailsafeAlert

protected

Observer for change notifications.

◆ m_obFanPWM

Cpl::Dm::SubscriberComposer<Api, Cpl::Dm::Mp::Uint32> Ajax::Metrics::Api::m_obFanPWM

protected

Observer for change notifications.

◆ m_obHeaterPWM

Cpl::Dm::SubscriberComposer<Api, Cpl::Dm::Mp::Uint32> Ajax::Metrics::Api::m_obHeaterPWM

protected

Observer for change notifications.

◆ m_opened

bool Ajax::Metrics::Api::m_opened

protected

open/close state

◆ m_runtimeMarker

uint32_t Ajax::Metrics::Api::m_runtimeMarker

protected

Time marker of when last updated the metrics to persistent storage.

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

Ajax/Metrics/Api.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Api()

Member Function Documentation

◆ expired()

◆ failsafeAlertChanged()

◆ fanPWMChanged()

◆ heaterPWMChanged()

◆ processFanMetric()

◆ processHeaterMetric()

◆ request() [1/2]

◆ request() [2/2]

Member Data Documentation

◆ m_fanMarker

◆ m_fanOn

◆ m_heaterMarker

◆ m_heaterOn

◆ m_obFailsafeAlert

◆ m_obFanPWM

◆ m_obHeaterPWM

◆ m_opened

◆ m_runtimeMarker