#include <MIDI_Outputs/Bankable/Abstract/MIDIButtons.hpp>

Detailed Description

template<class BankAddress, class Sender, uint8_t NumButtons>
class Bankable::MIDIButtons< BankAddress, Sender, NumButtons >

An abstract class for momentary push buttons that send MIDI events.

The buttons are debounced.

See also: Button

Definition at line 23 of file Bankable/Abstract/MIDIButtons.hpp.

Inheritance diagram for MIDIButtons< BankAddress, Sender, NumButtons >:

Collaboration diagram for MIDIButtons< BankAddress, Sender, NumButtons >:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

bool	isEnabled () const
	Check if this updatable is enabled.

void	moveDown ()
	Move down this element in the list.

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

template<class U , size_t N>
static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

template<class U , size_t N>
static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class.

static void	updateAll ()
	Update all enabled instances of this class.

Public Member Functions
void	begin () final override
	Initialize this updatable.

void	update () final override
	Update this updatable.

void	invert ()

AH::Button::State	getButtonState (size_t index) const

Public Attributes
Sender	sender

Protected Member Functions
	MIDIButtons (BankAddress bankAddress, const Array< AH::Button, NumButtons > &buttons, RelativeMIDIAddress incrementAddress, const Sender &sender)
	Construct a new MIDIButtons.

Protected Attributes
BankAddress	address

Array< AH::Button, NumButtons >	buttons

RelativeMIDIAddress	incrementAddress

uint8_t	activeButtons = 0

Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Constructor & Destructor Documentation

◆ MIDIButtons()

template<class BankAddress , class Sender , uint8_t NumButtons>

MIDIButtons	(	BankAddress	bankAddress,
		const Array< AH::Button, NumButtons > &	buttons,
		RelativeMIDIAddress	incrementAddress,
		const Sender &	sender )

inlineprotected

Construct a new MIDIButtons.

Definition at line 30 of file Bankable/Abstract/MIDIButtons.hpp.

Member Function Documentation

◆ begin()

template<class BankAddress , class Sender , uint8_t NumButtons>

void begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIButtons.hpp.

◆ update()

template<class BankAddress , class Sender , uint8_t NumButtons>

void update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 41 of file Bankable/Abstract/MIDIButtons.hpp.

◆ invert()

template<class BankAddress , class Sender , uint8_t NumButtons>

void invert ( )

inline

See also: AH::Button::invert()

Definition at line 63 of file Bankable/Abstract/MIDIButtons.hpp.

◆ getButtonState()

template<class BankAddress , class Sender , uint8_t NumButtons>

AH::Button::State getButtonState ( size_t index ) const

inline

Definition at line 68 of file Bankable/Abstract/MIDIButtons.hpp.

◆ beginAll()

template<class T = NormalUpdatable>

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

◆ enable() [2/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

template<class Derived >

template<class U , size_t N>

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 130 of file Updatable.hpp.

◆ disable() [1/4]

template<class Derived >

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 106 of file Updatable.hpp.

◆ disable() [2/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

template<class Derived >

template<class U , size_t N>

static void disable ( U(&) array[N] )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 141 of file Updatable.hpp.

◆ isEnabled()

template<class Derived >

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 120 of file Updatable.hpp.

◆ moveDown()

template<class Derived >

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.