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 Attributes | Private Attributes | Static Private Attributes | List of all members
MIDIButton< Sender > Class Template Reference

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

#include <MIDIButton.hpp>

Inheritance diagram for MIDIButton< Sender >:
Collaboration diagram for MIDIButton< Sender >:

Public Member Functions

 MIDIButton (pin_t pin, const MIDICNChannelAddress &address, const Sender &sender)
 Construct a new MIDIButton. More...
 
void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
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 Attributes

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

Private Attributes

Button button
 
const MIDICNChannelAddress address
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class Sender>
class MIDIButton< Sender >

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

The button is debounced.

See also
Button

Definition at line 17 of file Abstract/MIDIButton.hpp.

Constructor & Destructor Documentation

◆ MIDIButton()

template<class Sender>
MIDIButton< Sender >::MIDIButton ( pin_t  pin,
const MIDICNChannelAddress address,
const Sender &  sender 
)
inline

Construct a new MIDIButton.

Parameters
pinThe digital input pin with the button connected. The internal pull-up resistor will be enabled.
addressThe MIDI address to send to.
senderThe MIDI sender to use.

Definition at line 30 of file Abstract/MIDIButton.hpp.

Member Function Documentation

◆ begin()

template<class Sender>
void MIDIButton< Sender >::begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

template<class Sender>
void MIDIButton< Sender >::update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable<>.

Definition at line 35 of file Abstract/MIDIButton.hpp.

◆ getButtonState()

template<class Sender>
Button::State MIDIButton< Sender >::getButtonState ( ) const
inline

Definition at line 48 of file Abstract/MIDIButton.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

◆ button

template<class Sender>
Button MIDIButton< Sender >::button
private

Definition at line 51 of file Abstract/MIDIButton.hpp.

◆ address

template<class Sender>
const MIDICNChannelAddress MIDIButton< Sender >::address
private

Definition at line 52 of file Abstract/MIDIButton.hpp.

◆ sender

template<class Sender>
Sender MIDIButton< Sender >::sender

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