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

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

Detailed Description

template<class BankAddress, class Sender, uint8_t NumButtons>
class Bankable::MIDIButtons< BankAddress, Sender, NumButtons >

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

The buttons are debounced.

See also
Button

Definition at line 23 of file Bankable/Abstract/MIDIButtons.hpp.

+ Inheritance diagram for MIDIButtons< BankAddress, Sender, NumButtons >:
+ Collaboration diagram for MIDIButtons< BankAddress, Sender, NumButtons >:

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

void begin () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
void invert ()
 
AH::Button::State getButtonState (size_t index) const
 

Public Attributes

Sender sender
 

Protected Member Functions

 MIDIButtons (BankAddress bankAddress, const Array< AH::Button, NumButtons > &buttons, RelativeMIDIAddress incrementAddress, const Sender &sender)
 Construct a new MIDIButtons. More...
 

Protected Attributes

BankAddress address
 
Array< AH::Button, NumButtons > buttons
 
RelativeMIDIAddress incrementAddress
 
uint8_t activeButtons = 0
 
Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Constructor & Destructor Documentation

◆ MIDIButtons()

MIDIButtons ( BankAddress  bankAddress,
const Array< AH::Button, NumButtons > &  buttons,
RelativeMIDIAddress  incrementAddress,
const Sender &  sender 
)
inlineprotected

Construct a new MIDIButtons.

Definition at line 30 of file Bankable/Abstract/MIDIButtons.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

void update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 41 of file Bankable/Abstract/MIDIButtons.hpp.

◆ invert()

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

Definition at line 63 of file Bankable/Abstract/MIDIButtons.hpp.

◆ getButtonState()

AH::Button::State getButtonState ( size_t  index) const
inline

Definition at line 68 of file Bankable/Abstract/MIDIButtons.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

BankAddress address
protected

Definition at line 73 of file Bankable/Abstract/MIDIButtons.hpp.

◆ buttons

Array<AH::Button, NumButtons> buttons
protected

Definition at line 74 of file Bankable/Abstract/MIDIButtons.hpp.

◆ incrementAddress

RelativeMIDIAddress incrementAddress
protected

Definition at line 75 of file Bankable/Abstract/MIDIButtons.hpp.

◆ activeButtons

uint8_t activeButtons = 0
protected

Definition at line 76 of file Bankable/Abstract/MIDIButtons.hpp.

◆ sender

Sender sender

Definition at line 79 of file Bankable/Abstract/MIDIButtons.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: