Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
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.
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.

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

void begin () override
 Initialize this updatable.
void update () override
 Update this updatable.
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.

Protected Attributes

BankAddress address
AH::Button button
AH::BitArray< NumBanks > states
Updatable< NormalUpdatable > * next
Updatable< NormalUpdatable > * previous

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

template<uint8_t NumBanks, class BankAddress, class Sender>
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()

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

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

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

Update this updatable.

Implements Updatable< T >.

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

◆ toggleState()

template<uint8_t NumBanks, class BankAddress, class Sender>
bool toggleState ( )
inline

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

◆ getState()

template<uint8_t NumBanks, class BankAddress, class Sender>
bool getState ( ) const
inline

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

◆ setState()

template<uint8_t NumBanks, class BankAddress, class Sender>
void setState ( bool state)
inline

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

◆ getButtonState()

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

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

◆ beginAll()

template<class T = NormalUpdatable>
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>
void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 186 of file Updatable.hpp.

◆ enable()

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.

◆ disable()

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.

◆ 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 120 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ address

template<uint8_t NumBanks, class BankAddress, class Sender>
BankAddress address
protected

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

◆ button

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

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

◆ states

template<uint8_t NumBanks, class BankAddress, class Sender>
AH::BitArray<NumBanks> states
protected

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

◆ sender

template<uint8_t NumBanks, class BankAddress, class Sender>
Sender sender

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

◆ updatables

DoublyLinkedList<Updatable< NormalUpdatable >> updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable >* next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable >* previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0