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
MIDIButtons< Sender, NUMBER_OF_BUTTONS > Class Template Reference

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

#include <MIDIButtons.hpp>

Inheritance diagram for MIDIButtons< Sender, NUMBER_OF_BUTTONS >:
Collaboration diagram for MIDIButtons< Sender, NUMBER_OF_BUTTONS >:

Public Member Functions

void begin () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
Button::State getButtonState (size_t index) 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

 MIDIButtons (const Array< Button, NUMBER_OF_BUTTONS > &buttons, const MIDICNChannelAddress &baseAddress, const RelativeMIDICNChannelAddress &incrementAddress, const Sender &sender)
 Construct a new MIDIButtons. More...
 

Protected Attributes

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

Private Attributes

Array< Button, NUMBER_OF_BUTTONS > buttons
 
const MIDICNChannelAddress baseAddress
 
const RelativeMIDICNChannelAddress incrementAddress
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
class MIDIButtons< Sender, NUMBER_OF_BUTTONS >

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

The buttons are debounced.

See also
Button

Definition at line 18 of file Abstract/MIDIButtons.hpp.

Constructor & Destructor Documentation

◆ MIDIButtons()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
MIDIButtons< Sender, NUMBER_OF_BUTTONS >::MIDIButtons ( const Array< Button, NUMBER_OF_BUTTONS > &  buttons,
const MIDICNChannelAddress baseAddress,
const RelativeMIDICNChannelAddress incrementAddress,
const Sender &  sender 
)
inlineprotected

Construct a new MIDIButtons.

Todo:
Documentation

Definition at line 25 of file Abstract/MIDIButtons.hpp.

Member Function Documentation

◆ begin()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
void MIDIButtons< Sender, NUMBER_OF_BUTTONS >::begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

Definition at line 33 of file Abstract/MIDIButtons.hpp.

◆ update()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
void MIDIButtons< Sender, NUMBER_OF_BUTTONS >::update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

Definition at line 37 of file Abstract/MIDIButtons.hpp.

◆ getButtonState()

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
Button::State MIDIButtons< Sender, NUMBER_OF_BUTTONS >::getButtonState ( size_t  index) const
inline

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

◆ buttons

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
Array<Button, NUMBER_OF_BUTTONS> MIDIButtons< Sender, NUMBER_OF_BUTTONS >::buttons
private

Definition at line 62 of file Abstract/MIDIButtons.hpp.

◆ baseAddress

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
const MIDICNChannelAddress MIDIButtons< Sender, NUMBER_OF_BUTTONS >::baseAddress
private

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

◆ incrementAddress

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
const RelativeMIDICNChannelAddress MIDIButtons< Sender, NUMBER_OF_BUTTONS >::incrementAddress
private

Definition at line 64 of file Abstract/MIDIButtons.hpp.

◆ sender

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
Sender MIDIButtons< Sender, NUMBER_OF_BUTTONS >::sender

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