NoteChordButton Class Reference

#include <MIDI_Outputs/NoteChordButton.hpp>

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.

Inheritance diagram for NoteChordButton:

Collaboration diagram for NoteChordButton:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
bool	isEnabled () const
	Check if this updatable is enabled.
void	moveDown ()
	Move down this element in the list.

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

Public Member Functions
template<uint8_t N>
	NoteChordButton (pin_t pin, MIDIAddress address, Chord< N > chord, uint8_t velocity=0x7F)
	Create a new Bankable NoteChordButton object with the given pin, address and chord.
void	setVelocity (uint8_t velocity)
	Set the velocity of the MIDI Note events.
uint8_t	getVelocity () const
	Get the velocity of the MIDI Note events.
void	begin () final override
	Initialize this updatable.
void	update () final override
	Update this updatable.
void	invert ()
AH::Button::State	getButtonState () const
void	setChord (Chord< N > chord)
	Change the chord. Can be used safely while the push button is pressed.
MIDIAddress	getAddress () const
	Get the MIDI address.
void	setAddressUnsafe (MIDIAddress address)
	Set the MIDI address.

Public Attributes
DigitalNoteSender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next
Updatable< NormalUpdatable > *	previous

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

Private Attributes
AH::Button	button
MIDIAddress	address
std::unique_ptr< const IChord >	chord
std::unique_ptr< const IChord >	newChord

Constructor & Destructor Documentation

NoteChordButton()

template<uint8_t N>

NoteChordButton ( pin_t pin, MIDIAddress address, 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 47 of file NoteChordButton.hpp.

getVelocity()

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 49 of file NoteChordButton.hpp.

begin()

void begin ( )

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

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

update()

void update ( )

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

invert()

void invert ( )

inlineinherited

See also

invert()

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

getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

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

setChord()

void setChord ( Chord< N > chord )

inlineinherited

Change the chord. Can be used safely while the push button is pressed.

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

getAddress()

MIDIAddress getAddress ( ) const

inlineinherited

Get the MIDI address.

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

setAddressUnsafe()

void setAddressUnsafe ( MIDIAddress address )

inlineinherited

Set the MIDI address.

Has unexpected consequences if used while the push button is pressed. Use banks if you need to support that.

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

beginAll()

void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also

begin()

Definition at line 182 of file Updatable.hpp.

updateAll()

void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also

update()

Definition at line 186 of file Updatable.hpp.

enable()

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

disable()

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 106 of file Updatable.hpp.

isEnabled()

bool isEnabled ( ) const

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 120 of file Updatable.hpp.

moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

button

AH::Button button

privateinherited

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

address

MIDIAddress address

privateinherited

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

chord

std::unique_ptr<const IChord> chord

privateinherited

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

newChord

std::unique_ptr<const IChord> newChord

privateinherited

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

sender

DigitalNoteSender sender

inherited

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

updatables

DoublyLinkedList<Updatable< NormalUpdatable >> updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

next

Updatable< NormalUpdatable >* next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

previous

Updatable< NormalUpdatable >* previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

---

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

• NoteChordButton.hpp