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

#include <MIDIChordButton.hpp>

Inheritance diagram for MIDIChordButton< Sender >:

Collaboration diagram for MIDIChordButton< Sender >:

Public Member Functions
template<uint8_t N>
	MIDIChordButton (pin_t pin, const MIDICNChannelAddress &address, const Chord< N > &chord, const Sender &sender)
	Construct a new MIDIChordButton. More...

void	begin () final override
	Initialize this updatable. More...

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

AH::Button::State	getButtonState () const

template<uint8_t N>
void	setChord (const Chord< N > &chord)

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 Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
AH::Button	button

const MIDICNChannelAddress	address

AH::UniquePtr< const IChord >	chord

AH::UniquePtr< const IChord >	newChord

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

Detailed Description

template<class Sender>
class MIDIChordButton< Sender >

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

The button is debounced.

See also: AH::Button

Definition at line 20 of file Abstract/MIDIChordButton.hpp.

Constructor & Destructor Documentation

◆ MIDIChordButton()

template<class Sender>

template<uint8_t N>

MIDIChordButton< Sender >::MIDIChordButton	(	pin_t	pin,
		const MIDICNChannelAddress &	address,
		const Chord< N > &	chord,
		const Sender &	sender
	)

inline

Construct a new MIDIChordButton.

Parameters

pin	The digital input pin with the button connected. The internal pull-up resistor will be enabled.
address	The MIDI address of the base note, containing the note number [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
chord	The chord containing the intervals of the other notes to play.
sender	The MIDI Note sender to use.

Template Parameters

N	The number of notes in the chord.

Definition at line 41 of file Abstract/MIDIChordButton.hpp.

Member Function Documentation

◆ begin()

template<class Sender>

void MIDIChordButton< Sender >::begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements AH::Updatable<>.

Definition at line 47 of file Abstract/MIDIChordButton.hpp.

◆ update()

template<class Sender>

void MIDIChordButton< Sender >::update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements AH::Updatable<>.

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

◆ getButtonState()

template<class Sender>

AH::Button::State MIDIChordButton< Sender >::getButtonState ( ) const

inline

Definition at line 68 of file Abstract/MIDIChordButton.hpp.

◆ setChord()

template<class Sender>

template<uint8_t N>

void MIDIChordButton< Sender >::setChord ( const Chord< N > & chord )

inline

Definition at line 71 of file Abstract/MIDIChordButton.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

◆ button

template<class Sender>

AH::Button MIDIChordButton< Sender >::button

private

Definition at line 76 of file Abstract/MIDIChordButton.hpp.

◆ address

template<class Sender>

const MIDICNChannelAddress MIDIChordButton< Sender >::address

private

Definition at line 77 of file Abstract/MIDIChordButton.hpp.

◆ chord

template<class Sender>

AH::UniquePtr<const IChord> MIDIChordButton< Sender >::chord

private

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

◆ newChord

template<class Sender>

AH::UniquePtr<const IChord> MIDIChordButton< Sender >::newChord

private

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

◆ sender

template<class Sender>

Sender MIDIChordButton< Sender >::sender

Definition at line 82 of file Abstract/MIDIChordButton.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/MIDIChordButton.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

template<class Sender> class MIDIChordButton< Sender >

Constructor & Destructor Documentation

◆ MIDIChordButton()

Member Function Documentation

◆ begin()

◆ update()

◆ getButtonState()

◆ setChord()

◆ 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

◆ button

◆ address

◆ chord

◆ newChord

◆ sender

◆ updatables

◆ next

◆ previous

template<class Sender>
class MIDIChordButton< Sender >