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

#include <MIDIChordButton.hpp>

Inheritance diagram for Bankable::MIDIChordButton< Sender >:

Collaboration diagram for Bankable::MIDIChordButton< Sender >:

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

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

void	update () 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)

template<class U , size_t N>
static void	enable (U(&array)[N])

static void	disable (Updatable< T > *element)

static void	disable (Updatable< T > &element)

template<class U , size_t N>
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< T > *	next

Updatable< T > *	previous

Private Attributes
SingleAddress	address

AH::Button	button

AH::UniquePtr< const IChord >	chord

AH::UniquePtr< const IChord >	newChord

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

Detailed Description

template<class Sender>
class Bankable::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 23 of file Bankable/Abstract/MIDIChordButton.hpp.

Constructor & Destructor Documentation

◆ MIDIChordButton()

template<class Sender>

template<uint8_t N>

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

inline

Construct a new bankable MIDIChordButton.

Parameters

config	The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
pin	The digital input pin with the button connected. The internal pull-up resistor will be enabled.
address	The address of the base note, containing the note number [0, 127], the MIDI channel [CHANNEL_1, CHANNEL_16] and Cable Number [0, 15].
chord	The chord to play on top of the base notes.
sender	The MIDI sender to use.

Definition at line 44 of file Bankable/Abstract/MIDIChordButton.hpp.

Member Function Documentation

◆ begin()

template<class Sender>

void Bankable::MIDIChordButton< Sender >::begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements AH::Updatable< T >.

Definition at line 50 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ update()

template<class Sender>

void Bankable::MIDIChordButton< Sender >::update ( )

inlineoverridevirtual

Update this updatable.

Implements AH::Updatable< T >.

Definition at line 51 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ getButtonState()

template<class Sender>

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

inline

Definition at line 74 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ setChord()

template<class Sender>

template<uint8_t N>

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

inline

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

◆ enable() [1/4]

template<class T = NormalUpdatable>

void AH::Updatable< T >::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]

template<class T = NormalUpdatable>

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

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

template<class T = NormalUpdatable>

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

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

template<class T = NormalUpdatable>

template<class U , size_t N>

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

inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [1/4]

template<class T = NormalUpdatable>

void AH::Updatable< T >::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]

template<class T = NormalUpdatable>

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

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

template<class T = NormalUpdatable>

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

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

template<class T = NormalUpdatable>

template<class U , size_t N>

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

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

template<class T = NormalUpdatable>

bool AH::Updatable< T >::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()

template<class T = NormalUpdatable>

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

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>

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

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ address

template<class Sender>

SingleAddress Bankable::MIDIChordButton< Sender >::address

private

Definition at line 82 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ button

template<class Sender>

AH::Button Bankable::MIDIChordButton< Sender >::button

private

Definition at line 83 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ chord

template<class Sender>

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

private

Definition at line 84 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ newChord

template<class Sender>

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

private

Definition at line 85 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ sender

template<class Sender>

Sender Bankable::MIDIChordButton< Sender >::sender

Definition at line 88 of file Bankable/Abstract/MIDIChordButton.hpp.

◆ updatables

template<class T = NormalUpdatable>

DoublyLinkedList< Updatable< T > > AH::Updatable< T >::updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< T > * DoublyLinkable< Updatable< T > >::next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< T > * DoublyLinkable< Updatable< T > >::previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

Bankable/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 Bankable::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

◆ address

◆ button

◆ chord

◆ newChord

◆ sender

◆ updatables

◆ next

◆ previous

template<class Sender>
class Bankable::MIDIChordButton< Sender >