A class of MIDIOutputElements that read the input of a momentary push button or switch, and send out MIDI Note events. More...

#include <MIDI_Outputs/NoteChordButton.hpp>

Inheritance diagram for NoteChordButton:

Collaboration diagram for NoteChordButton:

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>
	NoteChordButton (pin_t pin, const MIDIAddress &address, const Chord< N > &chord, uint8_t velocity=0x7F)
	Create a new Bankable NoteChordButton object with the given pin, address and chord. More...

void	setVelocity (uint8_t velocity)
	Set the velocity of the MIDI Note events. More...

uint8_t	getVelocity () const
	Get the velocity of the MIDI Note events. More...

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

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

void	invert ()

AH::Button::State	getButtonState () const

void	setChord (const Chord< N > &chord)

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
DigitalNoteSender	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
AH::Button	button

const MIDIAddress	address

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

A class of MIDIOutputElements that read the input of a momentary push button or switch, and send out MIDI Note events.

A Note On event is sent when the button is pressed, and a Note Off event is sent when the button is released.
The button is debounced in software.
This version cannot be banked.

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

◆ NoteChordButton()

NoteChordButton	(	pin_t	pin,
		const MIDIAddress &	address,
		const Chord< N > &	chord,
		uint8_t	velocity = `0x7F`
	)

inline

Create a new Bankable NoteChordButton object with the given pin, address and chord.

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 [CABLE_1, CABLE_16].
chord	The chord containing the intervals of the other notes to play.
velocity	The velocity of the MIDI Note events.

Template Parameters

N	The number of notes in the chord.

Definition at line 41 of file NoteChordButton.hpp.

Member Function Documentation

◆ setVelocity()

void setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 51 of file NoteChordButton.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 53 of file NoteChordButton.hpp.

◆ begin()

void begin

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ invert()

void invert

inlineinherited

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

◆ getButtonState()

AH::Button::State getButtonState

inlineinherited

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

◆ setChord()

void setChord ( const Chord< N > & chord )

inlineinherited

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