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

#include <MIDIButtons.hpp>

Inheritance diagram for MIDIButtons< Sender, NUMBER_OF_BUTTONS >:

Collaboration diagram for MIDIButtons< Sender, NUMBER_OF_BUTTONS >:

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

void	update () final override
	Update this updatable. More...

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

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

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

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

Static Public Member Functions
static void	enable (Updatable *element)

static void	enable (Updatable &element)

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

static void	disable (Updatable< NormalUpdatable > *element)

static void	disable (Updatable< NormalUpdatable > &element)

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

static void	beginAll ()
	Begin all enabled instances of this class. More...

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

Public Attributes
Sender	sender

Protected Member Functions
	MIDIButtons (const Array< AH::Button, NUMBER_OF_BUTTONS > &buttons, const MIDICNChannelAddress &baseAddress, const RelativeMIDICNChannelAddress &incrementAddress, const Sender &sender)
	Construct a new MIDIButtons. More...

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

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

const MIDICNChannelAddress	baseAddress

const RelativeMIDICNChannelAddress	incrementAddress

Static Private Attributes
static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables

Detailed Description

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

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.

Constructor & Destructor Documentation

◆ MIDIButtons()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

MIDIButtons< Sender, NUMBER_OF_BUTTONS >::MIDIButtons	(	const Array< AH::Button, NUMBER_OF_BUTTONS > &	buttons,
		const MIDICNChannelAddress &	baseAddress,
		const RelativeMIDICNChannelAddress &	incrementAddress,
		const Sender &	sender
	)

inlineprotected

Construct a new MIDIButtons.

Todo:: Documentation

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

Member Function Documentation

◆ begin()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

void MIDIButtons< Sender, NUMBER_OF_BUTTONS >::begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements AH::Updatable<>.

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

◆ update()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

void MIDIButtons< Sender, NUMBER_OF_BUTTONS >::update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements AH::Updatable<>.

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

◆ getButtonState()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

AH::Button::State MIDIButtons< Sender, NUMBER_OF_BUTTONS >::getButtonState ( size_t index ) const

inline

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

◆ enable() [1/4]

void AH::Updatable< NormalUpdatable >::enable ( )

inlineinherited

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

Definition at line 45 of file Updatable.hpp.

◆ enable() [2/4]

static void AH::Updatable< NormalUpdatable >::enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

static void AH::Updatable< NormalUpdatable >::enable ( Updatable<> & element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

static void AH::Updatable< NormalUpdatable >::enable ( U(&) array[N] )

inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [1/4]

void AH::Updatable< NormalUpdatable >::disable ( )

inlineinherited

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

Definition at line 55 of file Updatable.hpp.

◆ disable() [2/4]

static void AH::Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > * element )

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

static void AH::Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > & element )

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

static void AH::Updatable< NormalUpdatable >::disable ( U(&) array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

bool AH::Updatable< NormalUpdatable >::isEnabled ( )

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 69 of file Updatable.hpp.

◆ beginAll()

static void AH::Updatable< NormalUpdatable >::beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

static void AH::Updatable< NormalUpdatable >::updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ buttons

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

Array<AH::Button, NUMBER_OF_BUTTONS> MIDIButtons< Sender, NUMBER_OF_BUTTONS >::buttons

private

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

◆ baseAddress

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

const MIDICNChannelAddress MIDIButtons< Sender, NUMBER_OF_BUTTONS >::baseAddress

private

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

◆ incrementAddress

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

const RelativeMIDICNChannelAddress MIDIButtons< Sender, NUMBER_OF_BUTTONS >::incrementAddress

private

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

◆ sender

template<class Sender, uint8_t NUMBER_OF_BUTTONS>

Sender MIDIButtons< Sender, NUMBER_OF_BUTTONS >::sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > AH::Updatable< NormalUpdatable >::updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

Abstract/MIDIButtons.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ MIDIButtons()

Member Function Documentation

◆ begin()

◆ update()

◆ getButtonState()

◆ 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()

◆ beginAll()

◆ updateAll()

Member Data Documentation

◆ buttons

◆ baseAddress

◆ incrementAddress

◆ sender

◆ updatables

◆ next

◆ previous

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