Driver::Button::PolledDebounced Class Reference

This concrete class implements a button driver where a single button is polled and its raw button state is de-bounced. More...

Detailed Description

This concrete class implements a button driver where a single button is polled and its raw button state is de-bounced.

The Application is responsible for the providing the sampling intervals by calling the interface's sample() method.

The application is RESPONSIBLE for ensuring that the 'button handle' is properly initialized before attempting to use the button driver instance.

The class is NOT thread safe. The application is RESPONSIBLE for ensuring thread-safe usage.

#include <PolledDebounced.h>

Public Member Functions
	PolledDebounced (Driver_Button_Hal_T buttonHandle, unsigned numConsecutiveCounts=2) noexcept
	Constructor.
void	start () noexcept
	This method is used to start/initialize the driver.
bool	isPressed () noexcept
	This method returns the de-bounced pressed button state.
void	sample () noexcept
	The application is required to call this method on fixed periodic intervals.
Driver_Button_Hal_T	getHandle ()
	Returns the driver's button handle.

Protected Attributes
Driver_Button_Hal_T	m_buttonHdl
	Handle to the button.
unsigned	m_requiredCount
	Required number of consecutive counts.
unsigned	m_counts
	Consecutive counts.
bool	m_previousRawPressed
	Previous raw state.
bool	m_pressed
	De-bounced state.

Constructor & Destructor Documentation

PolledDebounced()

Driver::Button::PolledDebounced::PolledDebounced ( Driver_Button_Hal_T  buttonHandle, unsigned  numConsecutiveCounts = 2  )

inlinenoexcept

Constructor.

The physical button being is sampled is specified by 'buttonHandle'. The 'numConsecutiveCounts' specifies the number of consecutive sample periods - without the raw button state changing - to declare a new de-bounced state.

Member Function Documentation

getHandle()

Driver_Button_Hal_T Driver::Button::PolledDebounced::getHandle ( )

inline

Returns the driver's button handle.

isPressed()

bool Driver::Button::PolledDebounced::isPressed ( )

inlinenoexcept

This method returns the de-bounced pressed button state.

sample()

void Driver::Button::PolledDebounced::sample ( )

noexcept

The application is required to call this method on fixed periodic intervals.

The raw button state is sampled during this call.

start()

void Driver::Button::PolledDebounced::start ( )

inlinenoexcept

This method is used to start/initialize the driver.

The method can also be used to restart the driver.

Member Data Documentation

m_buttonHdl

Driver_Button_Hal_T Driver::Button::PolledDebounced::m_buttonHdl

protected

Handle to the button.

m_counts

unsigned Driver::Button::PolledDebounced::m_counts

protected

Consecutive counts.

m_pressed

bool Driver::Button::PolledDebounced::m_pressed

protected

De-bounced state.

m_previousRawPressed

bool Driver::Button::PolledDebounced::m_previousRawPressed

protected

Previous raw state.

m_requiredCount

unsigned Driver::Button::PolledDebounced::m_requiredCount

protected

Required number of consecutive counts.

---

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

• Driver/Button/PolledDebounced.h