#include <MIDI_Outputs/Abstract/MIDIButtons.hpp>

Detailed Description

template<class Sender, uint8_t NumButtons>
class MIDIButtons< Sender, NumButtons >

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

The buttons are debounced.

See also: Button

Definition at line 17 of file Abstract/MIDIButtons.hpp.

Inheritance diagram for MIDIButtons< Sender, NumButtons >:

Collaboration diagram for MIDIButtons< 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.

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

MIDIAddress	getBaseAddress () const
	Get the MIDI base address.

void	setBaseAddressUnsafe (MIDIAddress address)
	Set the MIDI base address.

RelativeMIDIAddress	getIncrementAddress () const
	Get the MIDI increment address.

void	setIncrementAddressUnsafe (RelativeMIDIAddress address)
	Set the MIDI increment address.

void	invert ()

Public Attributes
Sender	sender

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

Protected Attributes
Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Private Attributes
Array< AH::Button, NumButtons >	buttons

MIDIAddress	baseAddress

RelativeMIDIAddress	incrementAddress

Constructor & Destructor Documentation

◆ MIDIButtons()

template<class Sender , uint8_t NumButtons>

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

inlineprotected

Construct a new MIDIButtons.

Definition at line 24 of file Abstract/MIDIButtons.hpp.

Member Function Documentation

◆ begin()

template<class Sender , uint8_t NumButtons>

void begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 31 of file Abstract/MIDIButtons.hpp.

◆ update()

template<class Sender , uint8_t NumButtons>

void update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 35 of file Abstract/MIDIButtons.hpp.

◆ getButtonState()

template<class Sender , uint8_t NumButtons>

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

inline

Definition at line 48 of file Abstract/MIDIButtons.hpp.

◆ getBaseAddress()

template<class Sender , uint8_t NumButtons>

MIDIAddress getBaseAddress ( ) const

inline

Get the MIDI base address.

Definition at line 53 of file Abstract/MIDIButtons.hpp.

◆ setBaseAddressUnsafe()

template<class Sender , uint8_t NumButtons>

void setBaseAddressUnsafe ( MIDIAddress address )

inline

Set the MIDI base address.

Has unexpected consequences if used while a push button is pressed. Use banks if you need to support that.

Definition at line 57 of file Abstract/MIDIButtons.hpp.

◆ getIncrementAddress()

template<class Sender , uint8_t NumButtons>

RelativeMIDIAddress getIncrementAddress ( ) const

inline

Get the MIDI increment address.

Definition at line 61 of file Abstract/MIDIButtons.hpp.

◆ setIncrementAddressUnsafe()

template<class Sender , uint8_t NumButtons>

void setIncrementAddressUnsafe ( RelativeMIDIAddress address )

inline

Set the MIDI increment address.

Has unexpected consequences if used while a push button is pressed. Use banks if you need to support that.

Definition at line 67 of file Abstract/MIDIButtons.hpp.

◆ invert()

template<class Sender , uint8_t NumButtons>

void invert ( )

inline

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

Definition at line 72 of file 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.

Member Data Documentation

◆ buttons

template<class Sender , uint8_t NumButtons>

Array<AH::Button, NumButtons> buttons

private

Definition at line 78 of file Abstract/MIDIButtons.hpp.

◆ baseAddress

template<class Sender , uint8_t NumButtons>

MIDIAddress baseAddress

private

Definition at line 79 of file Abstract/MIDIButtons.hpp.

◆ incrementAddress

template<class Sender , uint8_t NumButtons>

RelativeMIDIAddress incrementAddress

private

Definition at line 80 of file Abstract/MIDIButtons.hpp.

◆ sender

template<class Sender , uint8_t NumButtons>

Sender sender

Definition at line 83 of file Abstract/MIDIButtons.hpp.

◆ updatables

template<class Derived >

DoublyLinkedList< Derived > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

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

Abstract/MIDIButtons.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ MIDIButtons()

Member Function Documentation

◆ begin()

◆ update()

◆ getButtonState()

◆ getBaseAddress()

◆ setBaseAddressUnsafe()

◆ getIncrementAddress()

◆ setIncrementAddressUnsafe()

◆ invert()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ buttons

◆ baseAddress

◆ incrementAddress

◆ sender

◆ updatables

◆ next

◆ previous