A class of MIDIOutputElements that read the input of a momentary push button or toggle switch, and send out MIDI Note events. More...
#include <MIDI_Outputs/NoteButtonLatched.hpp>
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 | |
NoteButtonLatched (pin_t pin, const MIDIAddress &address, uint8_t velocity=0x7F) | |
Create a new NoteButtonLatched object on the given pin and with address. 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... | |
bool | toggleState () |
Flip the state (on → off or off → on). More... | |
bool | getState () const |
Get the current state. More... | |
void | setState (bool state) |
Set the state to the given value. More... | |
void | invert () |
AH::Button::State | getButtonState () const |
Get the state of the underlying button. More... | |
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 |
bool | state |
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... | |
A class of MIDIOutputElements that read the input of a momentary push button or toggle switch, and send out MIDI Note events.
It latches the input, so press once to enable, press again to disable (toggle).
The switch is debounced in software.
This version cannot be banked.
Definition at line 22 of file NoteButtonLatched.hpp.
|
inherited |
Definition at line 36 of file Updatable.hpp.
|
inherited |
Definition at line 38 of file Updatable.hpp.
|
inline |
Create a new NoteButtonLatched object on the given pin and with address.
pin | The digital input pin to read from. The internal pull-up resistor will be enabled. |
address | The MIDI address containing the note number [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16]. |
velocity | The velocity of the MIDI Note events. |
Definition at line 38 of file NoteButtonLatched.hpp.
|
inline |
Set the velocity of the MIDI Note events.
Definition at line 47 of file NoteButtonLatched.hpp.
|
inline |
Get the velocity of the MIDI Note events.
Definition at line 49 of file NoteButtonLatched.hpp.
|
inlinefinaloverridevirtualinherited |
Initialize this updatable.
Implements Updatable<>.
Definition at line 39 of file Abstract/MIDIButtonLatched.hpp.
|
inlinefinaloverridevirtualinherited |
Update this updatable.
Implements Updatable<>.
Definition at line 40 of file Abstract/MIDIButtonLatched.hpp.
|
inlineinherited |
Flip the state (on → off or off → on).
Sends the appropriate MIDI event.
Definition at line 48 of file Abstract/MIDIButtonLatched.hpp.
|
inlineinherited |
Get the current state.
Definition at line 54 of file Abstract/MIDIButtonLatched.hpp.
|
inlineinherited |
Set the state to the given value.
Sends the appropriate MIDI event.
Definition at line 58 of file Abstract/MIDIButtonLatched.hpp.
|
inlineinherited |
Definition at line 64 of file Abstract/MIDIButtonLatched.hpp.
|
inlineinherited |
Get the state of the underlying button.
Definition at line 68 of file Abstract/MIDIButtonLatched.hpp.
|
inlinestaticinherited |
Begin all enabled instances of this class.
Definition at line 208 of file Updatable.hpp.
|
inlinestaticinherited |
Update all enabled instances of this class.
Definition at line 212 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 79 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 85 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 93 of file Updatable.hpp.
|
inlineinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 106 of file Updatable.hpp.
|
inlineinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 115 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 144 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 146 of file Updatable.hpp.
|
inlinestaticinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 149 of file Updatable.hpp.
|
inlineinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 119 of file Updatable.hpp.
|
inlineinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 128 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 155 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 157 of file Updatable.hpp.
|
inlinestaticinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 160 of file Updatable.hpp.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 136 of file Updatable.hpp.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 141 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 166 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 168 of file Updatable.hpp.
|
privateinherited |
Definition at line 71 of file Abstract/MIDIButtonLatched.hpp.
|
privateinherited |
Definition at line 72 of file Abstract/MIDIButtonLatched.hpp.
|
privateinherited |
Definition at line 73 of file Abstract/MIDIButtonLatched.hpp.
|
inherited |
Definition at line 76 of file Abstract/MIDIButtonLatched.hpp.
|
staticprotectedinherited |
Definition at line 173 of file Updatable.hpp.
|
staticprotectedinherited |
Definition at line 174 of file Updatable.hpp.
|
protectedinherited |
Definition at line 323 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 324 of file LinkedList.hpp.