Control Surface main
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
MIDIChordButton< Sender > Class Template Reference

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

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.

+ Inheritance diagram for MIDIChordButton< Sender >:
+ Collaboration diagram for MIDIChordButton< Sender >:

Enabling and disabling updatables

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 () const
 Check if this updatable is enabled. 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...
 

Public Member Functions

template<uint8_t N>
 MIDIChordButton (OutputBankConfig<> config, pin_t pin, MIDIAddress address, 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 (Chord< N > chord)
 

Public Attributes

Sender sender
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

SingleAddress address
 
AH::Button button
 
std::unique_ptr< const IChordchord
 
std::unique_ptr< const IChordnewChord
 

Constructor & Destructor Documentation

◆ MIDIChordButton()

MIDIChordButton ( OutputBankConfig<>  config,
pin_t  pin,
MIDIAddress  address,
Chord< N >  chord,
const Sender &  sender 
)
inline

Construct a new bankable MIDIChordButton.

Parameters
configThe bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
pinThe digital input pin with the button connected. The internal pull-up resistor will be enabled.
addressThe 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].
chordThe chord to play on top of the base notes.
senderThe 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< T >.

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

◆ update()

void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

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

◆ invert()

void invert ( )
inline
See also
AH::Button::invert()

Definition at line 71 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 ( 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 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 190 of file Updatable.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 100 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > *  element)
inlinestaticinherited

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

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > &  element)
inlinestaticinherited

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

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

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

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

Definition at line 134 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 110 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > *  element)
inlinestaticinherited

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

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

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

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

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

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

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

Definition at line 145 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 124 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

Member Data Documentation

◆ address

SingleAddress address
private

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

◆ button

AH::Button button
private

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

◆ chord

std::unique_ptr<const IChord> chord
private

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

◆ newChord

std::unique_ptr<const IChord> newChord
private

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

◆ sender

Sender sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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