MIDIButton< Sender > Class Template Reference

#include <MIDI_Outputs/Abstract/MIDIButton.hpp>

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

Examples

Custom-MIDI-Sender.ino.

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

Inheritance diagram for MIDIButton< Sender >:

Collaboration diagram for MIDIButton< Sender >:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
bool	isEnabled () const
	Check if this updatable is enabled. More...
void	moveDown ()
	Move down this element in the list.
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
	MIDIButton (pin_t pin, MIDIAddress address, const Sender &sender)
	Construct a new MIDIButton. More...
void	begin () override
	Initialize this updatable. More...
void	update () override
	Update this updatable. More...
void	invert ()
AH::Button::State	getButtonState () const

Public Attributes
Sender	sender

Protected Attributes
Node *	next = nullptr
Node *	previous = nullptr

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables

Private Attributes
AH::Button	button
const MIDIAddress	address

Constructor & Destructor Documentation

MIDIButton()

MIDIButton ( pin_t  pin, MIDIAddress  address, const Sender &  sender  )

inline

Construct a new MIDIButton.

Parameters

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

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

Member Function Documentation

begin()

void begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

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

update()

void update ( )

inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

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

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() [2/3]

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() [3/3]

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/3]

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() [2/3]

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() [3/3]

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.

---

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

• Abstract/MIDIButton.hpp