ButtonMatrixInput Class Reference

Button matrix hardware. More...

#include <InputHardware.hpp>

Public Member Functions
	ButtonMatrixInput (const ButtonMatrix &matrix, bool negativeLogic=false)
	Construct a new Button Matrix Input object.
virtual uint64_t	read (uint64_t lastState) override
	Read the current state of the inputs (pressed or released)
Public Member Functions inherited from DigitalInput

Additional Inherited Members
Public Attributes inherited from DigitalInput
uint64_t	mask = ~0ULL
	Input mask. For read-only.
Protected Member Functions inherited from DigitalInput
void	addToMask (uint64_t bitmap)
	Add an input bitmap to the current mask.

Detailed Description

Button matrix hardware.

Definition at line 180 of file InputHardware.hpp.

Constructor & Destructor Documentation

ButtonMatrixInput()

ButtonMatrixInput::ButtonMatrixInput	(	const ButtonMatrix &	matrix,
		bool	negativeLogic = false )

Construct a new Button Matrix Input object.

Parameters

matrix	Button matrix specification
negativeLogic	True to use negative logic

Member Function Documentation

read()

virtual uint64_t ButtonMatrixInput::read ( uint64_t lastState )

overridevirtual

Read the current state of the inputs (pressed or released)

Warning

This function must not set any bit outside of the input bitmask in the return value.

Parameters

lastState

State of the same inputs as recorded in the previous iteration. Whether the current state is unknown, lastState must be returned (properly masked). Must be set to zero at first call.

Returns

uint64_t Current state of the inputs (a bit set to 1 means a pressed button).

Implements DigitalInput.

---

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

• /github/workspace/src/include/InputHardware.hpp