This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
Bankable::MIDIButtonLatched< BankAddress, Sender > Class Template Reference

A class for momentary buttons and switches that send MIDI events. More...

#include <MIDIButtonLatched.hpp>

Inheritance diagram for Bankable::MIDIButtonLatched< BankAddress, Sender >:
Collaboration diagram for Bankable::MIDIButtonLatched< BankAddress, Sender >:

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)
 
Button::State getButtonState () const
 
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 ()
 Check if this updatable is enabled. More...
 

Static Public Member Functions

static void enable (Updatable *element)
 
static void enable (Updatable &element)
 
static void enable (U(&array)[N])
 
static void disable (Updatable< NormalUpdatable > *element)
 
static void disable (Updatable< NormalUpdatable > &element)
 
static void disable (U(&array)[N])
 
static void beginAll ()
 Begin all enabled instances of this class. More...
 
static void updateAll ()
 Update all enabled instances of this class. More...
 

Public Attributes

Sender sender
 

Protected Member Functions

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

Protected Attributes

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

Private Attributes

BankAddress address
 
Button button
 
bool state = false
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class BankAddress, class Sender>
class Bankable::MIDIButtonLatched< 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
Button

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

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

template<class BankAddress, class Sender>
Bankable::MIDIButtonLatched< BankAddress, Sender >::MIDIButtonLatched ( const 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 35 of file Bankable/Abstract/MIDIButtonLatched.hpp.

Member Function Documentation

◆ begin()

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

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

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

Update this updatable.

Implements Updatable<>.

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

◆ toggleState()

template<class BankAddress, class Sender>
bool Bankable::MIDIButtonLatched< BankAddress, Sender >::toggleState ( )
inline

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

◆ getState()

template<class BankAddress, class Sender>
bool Bankable::MIDIButtonLatched< BankAddress, Sender >::getState ( ) const
inline

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

◆ setState()

template<class BankAddress, class Sender>
void Bankable::MIDIButtonLatched< BankAddress, Sender >::setState ( bool  state)
inline

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

◆ getButtonState()

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

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

◆ enable() [1/4]

void Updatable< NormalUpdatable >::enable ( )
inlineinherited

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

Definition at line 40 of file Updatable.hpp.

◆ enable() [2/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> &  element)
inlinestaticinherited

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

static void Updatable< NormalUpdatable >::enable ( U(&)  array[N])
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< NormalUpdatable >::disable ( )
inlineinherited

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

Definition at line 50 of file Updatable.hpp.

◆ disable() [2/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > *  element)
inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > &  element)
inlinestaticinherited

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

static void Updatable< NormalUpdatable >::disable ( U(&)  array[N])
inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< NormalUpdatable >::isEnabled ( )
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 64 of file Updatable.hpp.

◆ beginAll()

static void Updatable< NormalUpdatable >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll()

static void Updatable< NormalUpdatable >::updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

Member Data Documentation

◆ address

template<class BankAddress, class Sender>
BankAddress Bankable::MIDIButtonLatched< BankAddress, Sender >::address
private

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

◆ button

template<class BankAddress, class Sender>
Button Bankable::MIDIButtonLatched< BankAddress, Sender >::button
private

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

◆ state

template<class BankAddress, class Sender>
bool Bankable::MIDIButtonLatched< BankAddress, Sender >::state = false
private

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

◆ sender

template<class BankAddress, class Sender>
Sender Bankable::MIDIButtonLatched< BankAddress, Sender >::sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > Updatable< NormalUpdatable >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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