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

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

Detailed Description

template<uint8_t NumBanks, class BankAddress, class Sender>
class Bankable::MIDIButtonLatched< NumBanks, BankAddress, Sender >

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).

See also
AH::Button

Definition at line 22 of file Bankable/Abstract/MIDIButtonLatched.hpp.

+ Inheritance diagram for MIDIButtonLatched< NumBanks, BankAddress, Sender >:
+ Collaboration diagram for MIDIButtonLatched< NumBanks, BankAddress, 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

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
 

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

BankAddress address
 
AH::Button button
 
AH::BitArray< NumBanks > states
 
Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

MIDIButtonLatched ( BankAddress  bankAddress,
pin_t  pin,
const Sender &  sender 
)
inlineprotected

Create a new bankable MIDIButtonLatched object on the given pin and address.

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 36 of file Bankable/Abstract/MIDIButtonLatched.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 43 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ toggleState()

bool toggleState ( )
inline

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

◆ getState()

bool getState ( ) const
inline

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

◆ setState()

void setState ( bool  state)
inline

Definition at line 57 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ getButtonState()

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

Definition at line 66 of file Bankable/Abstract/MIDIButtonLatched.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 69 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ button

AH::Button button
protected

Definition at line 70 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ states

AH::BitArray<NumBanks> states
protected

Definition at line 71 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ sender

Sender sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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