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/Bankable/NoteChordButton.hpp>

Inheritance diagram for NoteChordButton:

Collaboration diagram for NoteChordButton:

Public Member Functions
template<uint8_t N>
	NoteChordButton (const OutputBankConfig &config, pin_t pin, const MIDICNChannelAddress &address, const Chord< N > &chord, uint8_t velocity=0x7F)
	Create a new Bankable NoteChordButton object with the given pin, note number, channel 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 () override
	Initialize this updatable. More...

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

void	invert ()

AH::Button::State	getButtonState () const

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
DigitalNoteSender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
SingleAddress	address

AH::Button	button

AH::UniquePtr< const IChord >	chord

AH::UniquePtr< const IChord >	newChord

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

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 can be banked.

Definition at line 21 of file Bankable/NoteChordButton.hpp.

Constructor & Destructor Documentation

◆ NoteChordButton()

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

inline

Create a new Bankable NoteChordButton object with the given pin, note number, channel and chord.

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 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.
velocity	The velocity of the MIDI Note events.

Template Parameters

N	The number of notes in the chord.

Definition at line 46 of file Bankable/NoteChordButton.hpp.

Member Function Documentation

◆ setVelocity()

void setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 54 of file Bankable/NoteChordButton.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 56 of file Bankable/NoteChordButton.hpp.

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ invert()

void invert ( )

inlineinherited

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

◆ getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

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

◆ setChord()

void setChord ( const Chord< N > & chord )

inlineinherited

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

◆ enable() [1/4]

void 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 enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( Updatable<> & element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

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

inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [1/4]

void 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 disable ( Updatable< NormalUpdatable<> > * element )

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

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

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

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

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

bool 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 beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ address

SingleAddress address

privateinherited

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

◆ button

AH::Button button

privateinherited

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

◆ chord

AH::UniquePtr<const IChord> chord

privateinherited

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

◆ newChord

AH::UniquePtr<const IChord> newChord

privateinherited

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

◆ sender

DigitalNoteSender sender

inherited

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

Bankable/NoteChordButton.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NoteChordButton()

Member Function Documentation

◆ setVelocity()

◆ getVelocity()

◆ begin()

◆ update()

◆ invert()

◆ 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