This class is responsible for 'translating' physical hardware signal to/from model point values. More...

Detailed Description

This class is responsible for 'translating' physical hardware signal to/from model point values.

The implementation assumes the existence of the following MP:

- cmdHeaterPWM
- cmdFanPWM
- hwSafetyLimit

#include <Api.h>

Inheritance diagram for Ajax::Heating::Io::Api:

[legend]

Collaboration diagram for Ajax::Heating::Io::Api:

[legend]

Public Member Functions
	Api (Cpl::Dm::MailboxServer &myMbox, Driver::DIO::Pwm &driverHeaterPwm, Driver::DIO::Pwm &driverFanPwm, Driver::DIO::In &driverHwSafetyIn) 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)

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	heaterPWMChanged (Cpl::Dm::Mp::Uint32 &mp, Cpl::Dm::SubscriberApi &clientObserver) noexcept
	Change notification.

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

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

void	intervalExpired () noexcept
	Helper method than reads/writes the hardware.

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_obHeaterPWM
	Observer for change notification.

Cpl::Dm::SubscriberComposer< Api, Cpl::Dm::Mp::Uint32 >	m_obFanPWM
	Observer for change notification.

Driver::DIO::Pwm &	m_driverHeaterPwm
	Driver handle.

Driver::DIO::Pwm &	m_driverFanPwm
	Driver handle.

Driver::DIO::In &	m_driverHwSafetyIn
	Driver handle.

uint32_t	m_timeMarker
	Period time marker.

bool	m_firstExecution
	Flag for initial execution pass.

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.

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::Heating::Io::Api::Api	(	Cpl::Dm::MailboxServer &	myMbox,
		Driver::DIO::Pwm &	driverHeaterPwm,
		Driver::DIO::Pwm &	driverFanPwm,
		Driver::DIO::In &	driverHwSafetyIn
	)

noexcept

Constructor.

Member Function Documentation

◆ expired()

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

protectedvirtualnoexcept

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

Implements Cpl::System::CounterCallback_.

◆ fanPWMChanged()

void Ajax::Heating::Io::Api::fanPWMChanged	(	Cpl::Dm::Mp::Uint32 &	mp,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

Change notification.

◆ heaterPWMChanged()

void Ajax::Heating::Io::Api::heaterPWMChanged	(	Cpl::Dm::Mp::Uint32 &	mp,
		Cpl::Dm::SubscriberApi &	clientObserver
	)

protectednoexcept

Change notification.

◆ intervalExpired()

void Ajax::Heating::Io::Api::intervalExpired ( )

protectednoexcept

Helper method than reads/writes the hardware.

◆ request() [1/2]

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

virtual

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

Implements Cpl::Itc::CloseRequest.

◆ request() [2/2]

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

virtual

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

Implements Cpl::Itc::OpenRequest.

Member Data Documentation

◆ m_driverFanPwm

Driver::DIO::Pwm& Ajax::Heating::Io::Api::m_driverFanPwm

protected

Driver handle.

◆ m_driverHeaterPwm

Driver::DIO::Pwm& Ajax::Heating::Io::Api::m_driverHeaterPwm

protected

Driver handle.

◆ m_driverHwSafetyIn

Driver::DIO::In& Ajax::Heating::Io::Api::m_driverHwSafetyIn

protected

Driver handle.

◆ m_firstExecution

bool Ajax::Heating::Io::Api::m_firstExecution

protected

Flag for initial execution pass.

◆ m_obFanPWM

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

protected

Observer for change notification.

◆ m_obHeaterPWM

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

protected

Observer for change notification.

◆ m_opened

bool Ajax::Heating::Io::Api::m_opened

protected

Open state.

◆ m_timeMarker

uint32_t Ajax::Heating::Io::Api::m_timeMarker

protected

Period time marker.

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

Ajax/Heating/Io/Api.h

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Api()

Member Function Documentation

◆ expired()

◆ fanPWMChanged()

◆ heaterPWMChanged()

◆ intervalExpired()

◆ request() [1/2]

◆ request() [2/2]

Member Data Documentation

◆ m_driverFanPwm

◆ m_driverHeaterPwm

◆ m_driverHwSafetyIn

◆ m_firstExecution

◆ m_obFanPWM

◆ m_obHeaterPWM

◆ m_opened

◆ m_timeMarker