A class for momentary buttons and switches that send MIDI events. More...
#include <MIDI_Outputs/Bankable/Abstract/MIDIButtonLatched.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 | |
void | begin () override |
Initialize this updatable. More... | |
void | update () override |
Update this updatable. More... | |
bool | toggleState () |
bool | getState () const |
void | setState (bool state) |
AH::Button::State | getButtonState () const |
Static Public Member Functions | |
static Mutex & | getMutex () |
Public Attributes | |
Sender | sender |
Protected Member Functions | |
MIDIButtonLatched (BankAddress bankAddress, pin_t pin, const Sender &sender) | |
Create a new bankable MIDIButtonLatched object on the given pin and address. More... | |
Protected Attributes | |
Updatable< NormalUpdatable, false > * | next |
Updatable< NormalUpdatable, false > * | previous |
Static Protected Attributes | |
static DoublyLinkedList< Updatable< NormalUpdatable, false > > | updatables |
static Mutex | mutex |
Private Attributes | |
BankAddress | address |
AH::Button | button |
AH::BitArray< NumBanks > | states |
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 for momentary buttons and switches that send MIDI events.
The button is debounced, and the button is latched (press once to enable, press again to disable) (toggle).
Definition at line 22 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
inherited |
Definition at line 36 of file Updatable.hpp.
|
inherited |
Definition at line 38 of file Updatable.hpp.
|
inlineprotected |
Create a new bankable MIDIButtonLatched object on the given pin and address.
bankAddress | The bankable MIDI address to send to. |
pin | The digital input pin with the button connected. The internal pull-up resistor will be enabled. |
sender | The MIDI sender to use. |
Definition at line 36 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
inlineoverridevirtual |
Initialize this updatable.
Implements Updatable<>.
Definition at line 41 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
inlineoverridevirtual |
Update this updatable.
Implements Updatable<>.
Definition at line 43 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
inline |
Definition at line 49 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
inline |
Definition at line 55 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
inline |
Definition at line 57 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
inline |
Definition at line 66 of file Bankable/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.
|
private |
Definition at line 69 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
private |
Definition at line 70 of file Bankable/Abstract/MIDIButtonLatched.hpp.
|
private |
Definition at line 71 of file Bankable/Abstract/MIDIButtonLatched.hpp.
Sender sender |
Definition at line 74 of file Bankable/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.