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

#include <MIDI_Outputs/Abstract/MIDIButtonLatched.hpp>

Detailed Description

template<class Sender>
class MIDIButtonLatched< 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
Button

Definition at line 20 of file Abstract/MIDIButtonLatched.hpp.

+ Inheritance diagram for MIDIButtonLatched< Sender >:
+ Collaboration diagram for MIDIButtonLatched< 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 () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
bool toggleState ()
 Flip the state (on → off or off → on). More...
 
bool getState () const
 Get the current state. More...
 
void setState (bool state)
 Set the state to the given value. More...
 
void invert ()
 
AH::Button::State getButtonState () const
 Get the state of the underlying button. More...
 
MIDIAddress getAddress () const
 Get the MIDI address. More...
 
void setAddressUnsafe (MIDIAddress address)
 Set the MIDI address. More...
 

Public Attributes

Sender sender
 

Protected Member Functions

 MIDIButtonLatched (pin_t pin, MIDIAddress address, const Sender &sender)
 Create a new MIDIButtonLatched object on the given pin and address. More...
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

AH::Button button
 
const MIDIAddress address
 
bool state = false
 

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

MIDIButtonLatched ( pin_t  pin,
MIDIAddress  address,
const Sender &  sender 
)
inlineprotected

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

Parameters
pinThe digital input pin to read from.
The internal pull-up resistor will be enabled.
addressThe MIDI address to send to.
senderThe MIDI sender to use.

Definition at line 34 of file Abstract/MIDIButtonLatched.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 38 of file Abstract/MIDIButtonLatched.hpp.

◆ update()

void update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 39 of file Abstract/MIDIButtonLatched.hpp.

◆ toggleState()

bool toggleState ( )
inline

Flip the state (on → off or off → on).

Sends the appropriate MIDI event.

Definition at line 47 of file Abstract/MIDIButtonLatched.hpp.

◆ getState()

bool getState ( ) const
inline

Get the current state.

Definition at line 53 of file Abstract/MIDIButtonLatched.hpp.

◆ setState()

void setState ( bool  state)
inline

Set the state to the given value.

Sends the appropriate MIDI event.

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

◆ invert()

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

Definition at line 63 of file Abstract/MIDIButtonLatched.hpp.

◆ getButtonState()

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

Get the state of the underlying button.

Definition at line 66 of file Abstract/MIDIButtonLatched.hpp.

◆ getAddress()

MIDIAddress getAddress ( ) const
inline

Get the MIDI address.

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

◆ setAddressUnsafe()

void setAddressUnsafe ( MIDIAddress  address)
inline

Set the MIDI address.

Has unexpected consequences if used while the button is active. Use banks if you need to support that.

Definition at line 72 of file 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

◆ button

AH::Button button
private

Definition at line 75 of file Abstract/MIDIButtonLatched.hpp.

◆ address

const MIDIAddress address
private

Definition at line 76 of file Abstract/MIDIButtonLatched.hpp.

◆ state

bool state = false
private

Definition at line 77 of file Abstract/MIDIButtonLatched.hpp.

◆ sender

Sender sender

Definition at line 80 of file Abstract/MIDIButtonLatched.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: