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

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

Inheritance diagram for MIDIChordButton< Sender >:

Collaboration diagram for MIDIChordButton< Sender >:

Public Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
template<uint8_t N>
	MIDIChordButton (OutputBankConfig<> config, pin_t pin, MIDIAddress 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...

void	invert ()

AH::Button::State	getButtonState () const

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

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
Sender	sender

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
SingleAddress	address

AH::Button	button

AH::UniquePtr< const IChord >	chord

AH::UniquePtr< const IChord >	newChord

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

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

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

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer 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 (const LockGuard &) const
	Check if this updatable is enabled. More...

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

void	moveDown (const LockGuard &)
	Move down this element in the list. More...

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

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

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

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

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

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

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

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

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

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.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ MIDIChordButton()

MIDIChordButton	(	OutputBankConfig<>	config,
		pin_t	pin,
		MIDIAddress	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 [CABLE_1, CABLE_16].
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()

void begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update ( )

inlineoverridevirtual

Update this updatable.

Implements Updatable<>.

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

◆ invert()

void invert ( )

inline

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

◆ getButtonState()

AH::Button::State getButtonState ( ) const

inline

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

◆ setChord()

void setChord ( const Chord< N > & chord )

inline

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

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.