Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
MIDIButton< BankAddress, Sender > Class Template Reference

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

Detailed Description

template<class BankAddress, class Sender>
class Bankable::MIDIButton< BankAddress, Sender >

An abstract class for momentary push buttons that send MIDI events.

The button is debounced.

See also
Button

Definition at line 20 of file Bankable/Abstract/MIDIButton.hpp.

+ Inheritance diagram for MIDIButton< BankAddress, Sender >:
+ Collaboration diagram for MIDIButton< BankAddress, Sender >:

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.
 
static void enable (UpdatableCRTP *element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
static void enable (UpdatableCRTP &element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
template<class U , size_t N>
static void enable (U(&array)[N])
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
static void disable (UpdatableCRTP *element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 
static void disable (UpdatableCRTP &element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 
template<class U , size_t N>
static void disable (U(&array)[N])
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 

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

 MIDIButton (BankAddress bankAddress, pin_t pin, const Sender &sender)
 Construct a new bankable MIDIButton.
 
void begin () override
 Initialize this updatable.
 
void update () override
 Update this updatable.
 
void invert ()
 
AH::Button::State getButtonState () const
 

Public Attributes

Sender sender
 

Protected Attributes

BankAddress address
 
AH::Button button
 
Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Constructor & Destructor Documentation

◆ MIDIButton()

template<class BankAddress , class Sender >
MIDIButton ( BankAddress bankAddress,
pin_t pin,
const Sender & sender )
inline

Construct a new bankable MIDIButton.

Parameters
bankAddressThe bankable MIDI address to send to.
pinThe digital input pin with the button connected. The internal pull-up resistor will be enabled.
senderThe MIDI sender to use.

Definition at line 33 of file Bankable/Abstract/MIDIButton.hpp.

Member Function Documentation

◆ begin()

template<class BankAddress , class Sender >
void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 36 of file Bankable/Abstract/MIDIButton.hpp.

◆ update()

template<class BankAddress , class Sender >
void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIButton.hpp.

◆ invert()

template<class BankAddress , class Sender >
void invert ( )
inline
See also
AH::Button::invert()

Definition at line 49 of file Bankable/Abstract/MIDIButton.hpp.

◆ getButtonState()

template<class BankAddress , class Sender >
AH::Button::State getButtonState ( ) const
inline

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

◆ beginAll()

template<class T = NormalUpdatable>
static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>
static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >
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.

◆ enable() [2/4]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > * element)
inlinestaticinherited

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

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > & element)
inlinestaticinherited

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

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

template<class Derived >
template<class U , size_t N>
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 130 of file Updatable.hpp.

◆ disable() [1/4]

template<class Derived >
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.

◆ disable() [2/4]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > * element)
inlinestaticinherited

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

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > & element)
inlinestaticinherited

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

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

template<class Derived >
template<class U , size_t N>
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 141 of file Updatable.hpp.

◆ isEnabled()

template<class Derived >
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()

template<class Derived >
void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ address

template<class BankAddress , class Sender >
BankAddress address
protected

Definition at line 54 of file Bankable/Abstract/MIDIButton.hpp.

◆ button

template<class BankAddress , class Sender >
AH::Button button
protected

Definition at line 55 of file Bankable/Abstract/MIDIButton.hpp.

◆ sender

template<class BankAddress , class Sender >
Sender sender

Definition at line 58 of file Bankable/Abstract/MIDIButton.hpp.

◆ updatables

template<class Derived >
DoublyLinkedList< Derived > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.


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