MIDIButton< BankAddress, Sender > Class Template Reference

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

#include <MIDI_Outputs/Bankable/Abstract/MIDIButton.hpp>

Inheritance diagram for MIDIButton< BankAddress, Sender >:

Collaboration diagram for MIDIButton< BankAddress, Sender >:

Public Member Functions
	MIDIButton (const BankAddress &bankAddress, pin_t pin, const Sender &sender)
	Construct a new bankable MIDIButton. More...
void	begin () override
	Initialize this updatable. More...
void	update () override
	Update this updatable. More...
void	invert ()
AH::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)
template<class U , size_t N>
static void	enable (U(&array)[N])
static void	disable (Updatable< T > *element)
static void	disable (Updatable< T > &element)
template<class U , size_t N>
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< T > *	next
Updatable< T > *	previous

Private Attributes
BankAddress	address
AH::Button	button

Static Private Attributes
static DoublyLinkedList< Updatable< T > >	updatables

Detailed Description

template<class BankAddress, class Sender>
class Bankable::MIDIButton< BankAddress, Sender >

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

The button is debounced.

See also

Button

Definition at line 20 of file Bankable/Abstract/MIDIButton.hpp.

Constructor & Destructor Documentation

MIDIButton()

MIDIButton ( const BankAddress &  bankAddress, pin_t  pin, const Sender &  sender  )

inline

Construct a new bankable MIDIButton.

Parameters

bankAddress	The bankable MIDI address to send to.
pin	The digital input pin with the button connected. The internal pull-up resistor will be enabled.
sender	The MIDI sender to use.

Definition at line 33 of file Bankable/Abstract/MIDIButton.hpp.

Member Function Documentation

begin()

void begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 36 of file Bankable/Abstract/MIDIButton.hpp.

update()

void update ( )

inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIButton.hpp.

invert()

void invert ( )

inline

Definition at line 49 of file Bankable/Abstract/MIDIButton.hpp.

getButtonState()

AH::Button::State getButtonState ( ) const

inline

Definition at line 52 of file Bankable/Abstract/MIDIButton.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 45 of file Updatable.hpp.

enable() [2/4]

static void enable ( Updatable< T > *  element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

enable() [3/4]

static void enable ( Updatable< T > &  element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

enable() [4/4]

static void enable ( U(&)  array[N] )

inlinestaticinherited

Definition at line 90 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 55 of file Updatable.hpp.

disable() [2/4]

static void disable ( Updatable< T > *  element )

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

disable() [3/4]

static void disable ( Updatable< T > &  element )

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

disable() [4/4]

static void disable ( U(&)  array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

isEnabled()

bool 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 69 of file Updatable.hpp.

beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also

begin()

Definition at line 73 of file Updatable.hpp.

updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also

update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

address

BankAddress address

private

Definition at line 55 of file Bankable/Abstract/MIDIButton.hpp.

button

AH::Button button

private

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

sender

Sender sender

Definition at line 59 of file Bankable/Abstract/MIDIButton.hpp.

updatables

DoublyLinkedList< Updatable< T > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

next

Updatable< T > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

previous

Updatable< T > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

---

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

• Bankable/Abstract/MIDIButton.hpp