This class implements the Heating Algorithm Supervisor. More...

Detailed Description

This class implements the Heating Algorithm Supervisor.

The supervisor is responsible for "managing/sequencing' the heating algorithm

All inputs and outputs (including alerts) are done via Model Points. The model point references are via 'hard coded' model point names.

The class is NOT thread safe.

#include <Api.h>

Inheritance diagram for Ajax::Heating::Supervisor::Api:

[legend]

Collaboration diagram for Ajax::Heating::Supervisor::Api:

[legend]

Public Member Functions
	Api (Cpl::Dm::MailboxServer &myMbox) noexcept
	Constructor.

void	request (OpenMsg &msg)
	This method starts the supervisor (See Cpl::Itc::OpenSync)

void	request (CloseMsg &msg)
	This method stops the supervisor (See Cpl::Itc::CloseSync)

bool	isSensorAvailable () noexcept
	Guard.

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.

Public Member Functions inherited from Ajax::Heating::Supervisor::FsmEventQueue_
	FsmEventQueue_ (EventCompletedCbFunc_T eventCompletedCallback=nullptr)
	Constructor.

virtual void	generateEvent (FSM_EVENT_T msg)
	This method properly queues and process event messages.

Public Member Functions inherited from Cpl::Container::RingBuffer< FSM_EVENT_T >
	RingBuffer (unsigned numElements, FSM_EVENT_T memoryForElements[]) noexcept
	Constructor.

bool	remove (FSM_EVENT_T &dst) noexcept
	Removes the first item in the Buffer.

bool	add (const FSM_EVENT_T &item) noexcept
	The contents of 'item' will be copied into the Ring Buffer as the 'last' item in the buffer.

FSM_EVENT_T *	peekHead (void) const noexcept
	Returns a pointer to the first item in the Buffer.

FSM_EVENT_T *	peekTail (void) const noexcept
	Returns a pointer to the last item in the Buffer.

bool	isEmpty (void) const noexcept
	This method returns true if the Ring Buffer is empty.

bool	isFull (void) const noexcept
	This method returns true if the Ring Buffer is full.

unsigned	getNumItems (void) const noexcept
	This method returns the current number of items in the Ring Buffer.

unsigned	getMaxItems (void) const noexcept
	This method returns the maximum number of items that can be stored in the Ring buffer.

void	clearTheBuffer () noexcept
	Empties the Ring Buffer.

FSM_EVENT_T *	peekNextRemoveItems (unsigned &dstNumFlatElements) noexcept
	This method returns a pointer to the next item to be removed.

void	removeElements (unsigned numElementsToRemove) noexcept
	This method 'removes' N elements - that were removed using the pointer returned from peekNextRemoveItems - from the ring buffer.

FSM_EVENT_T *	peekNextAddItems (unsigned &dstNumFlatElements) noexcept
	This method returns a pointer to the next item to be added.

void	addElements (unsigned numElementsAdded) noexcept
	This method 'adds' N elements - that were populated using the pointer returned from peekNextAddItems - to the ring buffer.

Protected Member Functions
void	allOff () noexcept
	Action.

void	checkForSensor () noexcept
	Action.

void	fanOff () noexcept
	Action.

void	fanOn () noexcept
	Action.

void	heatOff () noexcept
	Action.

void	runHeatingAlgo () noexcept
	Action.

void	expired () noexcept
	See Cpl::System::Timer (timer expired callback)

void	hwSafetyChanged (Cpl::Dm::Mp::Bool &mp, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Change notification.

void	heatingEnabledChanged (Cpl::Dm::Mp::Bool &mp, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Change notification.

bool	getTemperature (int32_t &idt) noexcept
	Helper method to select temperature source. Returns false if there is no valid temperature source.

void	scheduleAlgorithm () noexcept
	Helper method that schedules when the algorithm executes.

virtual void	intervalExpired () noexcept
	Helper method that is called when the algorithm's periodic interval has expired, i.e.

uint32_t	getFanPWM () noexcept
	Helper method that gets the fan setting.

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
Ajax::Heating::Flc::Api	m_flcController
	Heating controller.

Cpl::Dm::SubscriberComposer< Api, Cpl::Dm::Mp::Bool >	m_obHwSafety
	Observer for change notification (to the hardware temperature safety limit)

Cpl::Dm::SubscriberComposer< Api, Cpl::Dm::Mp::Bool >	m_obHeatingEnabled
	Observer for change notification (to the heating mode)

int32_t	m_sumCapacityRequest
	Accumulated capacity requests.

uint32_t	m_timeMarker
	Timer marker of last processing cycle.

uint32_t	m_maxCapacity
	Maximum capacity.

bool	m_firstExecution
	Flag for first execution of the algorithm.

bool	m_temperatureSensorAvailable
	Temperature sensor available.

bool	m_opened
	Open 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.

Protected Attributes inherited from Ajax::Heating::Supervisor::FsmEventQueue_
EventCompletedCbFunc_T	m_eventCompletedCallback
	Optional Callback function for event-completed (typically used for unit testing purposes)

FSM_EVENT_T	m_eventQueMemory [4]
	Memory for Event queue.

bool	m_processingFsmEvent
	Flag for tracking re-entrant events.

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.

Public Types inherited from Ajax::Heating::Supervisor::FsmEventQueue_
typedef void(*	EventCompletedCbFunc_T) (FSM_EVENT_T proceessedMsg)
	Define callback function that is called when an event has completed.

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

noexcept

Constructor.

Member Function Documentation

◆ allOff()

void Ajax::Heating::Supervisor::Api::allOff ( )

protectednoexcept

Action.

◆ checkForSensor()

void Ajax::Heating::Supervisor::Api::checkForSensor ( )

protectednoexcept

Action.

◆ expired()

void Ajax::Heating::Supervisor::Api::expired ( )

protectedvirtualnoexcept

See Cpl::System::Timer (timer expired callback)

Implements Cpl::System::CounterCallback_.

◆ fanOff()

void Ajax::Heating::Supervisor::Api::fanOff ( )

protectednoexcept

Action.

◆ fanOn()

void Ajax::Heating::Supervisor::Api::fanOn ( )

protectednoexcept

Action.

◆ getFanPWM()

uint32_t Ajax::Heating::Supervisor::Api::getFanPWM ( )

protectednoexcept

Helper method that gets the fan setting.

◆ getTemperature()

bool Ajax::Heating::Supervisor::Api::getTemperature ( int32_t & idt )

protectednoexcept

Helper method to select temperature source. Returns false if there is no valid temperature source.

◆ heatingEnabledChanged()

void Ajax::Heating::Supervisor::Api::heatingEnabledChanged	(	Cpl::Dm::Mp::Bool &	mp,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

Change notification.

◆ heatOff()

void Ajax::Heating::Supervisor::Api::heatOff ( )

protectednoexcept

Action.

◆ hwSafetyChanged()

void Ajax::Heating::Supervisor::Api::hwSafetyChanged	(	Cpl::Dm::Mp::Bool &	mp,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

Change notification.

◆ intervalExpired()

virtual void Ajax::Heating::Supervisor::Api::intervalExpired ( )

protectedvirtualnoexcept

Helper method that is called when the algorithm's periodic interval has expired, i.e.

the periodic execution of the algorithm

Reimplemented in Ajax::Heating::Simulated::House.

◆ isSensorAvailable()

bool Ajax::Heating::Supervisor::Api::isSensorAvailable ( )

noexcept

Guard.

◆ request() [1/2]

void Ajax::Heating::Supervisor::Api::request ( CloseMsg & msg )

virtual

This method stops the supervisor (See Cpl::Itc::CloseSync)

Implements Cpl::Itc::CloseRequest.

◆ request() [2/2]

void Ajax::Heating::Supervisor::Api::request ( OpenMsg & msg )

virtual

This method starts the supervisor (See Cpl::Itc::OpenSync)

Implements Cpl::Itc::OpenRequest.

◆ runHeatingAlgo()

void Ajax::Heating::Supervisor::Api::runHeatingAlgo ( )

protectednoexcept

Action.

◆ scheduleAlgorithm()

void Ajax::Heating::Supervisor::Api::scheduleAlgorithm ( )

protectednoexcept

Helper method that schedules when the algorithm executes.

Member Data Documentation

◆ m_firstExecution

bool Ajax::Heating::Supervisor::Api::m_firstExecution

protected

Flag for first execution of the algorithm.

◆ m_flcController

Ajax::Heating::Flc::Api Ajax::Heating::Supervisor::Api::m_flcController

protected

Heating controller.

◆ m_maxCapacity

uint32_t Ajax::Heating::Supervisor::Api::m_maxCapacity

protected

Maximum capacity.

◆ m_obHeatingEnabled

Cpl::Dm::SubscriberComposer<Api, Cpl::Dm::Mp::Bool> Ajax::Heating::Supervisor::Api::m_obHeatingEnabled

protected

Observer for change notification (to the heating mode)

◆ m_obHwSafety

Cpl::Dm::SubscriberComposer<Api, Cpl::Dm::Mp::Bool> Ajax::Heating::Supervisor::Api::m_obHwSafety

protected

Observer for change notification (to the hardware temperature safety limit)

◆ m_opened

bool Ajax::Heating::Supervisor::Api::m_opened

protected

Open state.

◆ m_sumCapacityRequest

int32_t Ajax::Heating::Supervisor::Api::m_sumCapacityRequest

protected

Accumulated capacity requests.

◆ m_temperatureSensorAvailable

bool Ajax::Heating::Supervisor::Api::m_temperatureSensorAvailable

protected

Temperature sensor available.

◆ m_timeMarker

uint32_t Ajax::Heating::Supervisor::Api::m_timeMarker

protected

Timer marker of last processing cycle.

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

Ajax/Heating/Supervisor/Api.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Api()

Member Function Documentation

◆ allOff()

◆ checkForSensor()

◆ expired()

◆ fanOff()

◆ fanOn()

◆ getFanPWM()

◆ getTemperature()

◆ heatingEnabledChanged()

◆ heatOff()

◆ hwSafetyChanged()

◆ intervalExpired()

◆ isSensorAvailable()

◆ request() [1/2]

◆ request() [2/2]

◆ runHeatingAlgo()

◆ scheduleAlgorithm()

Member Data Documentation

◆ m_firstExecution

◆ m_flcController

◆ m_maxCapacity

◆ m_obHeatingEnabled

◆ m_obHwSafety

◆ m_opened

◆ m_sumCapacityRequest

◆ m_temperatureSensorAvailable

◆ m_timeMarker