#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. More...

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

bool	isEnabled () const
	Check if this updatable is enabled. More...

void	moveDown ()
	Move down this element in the list. 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 (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

MIDIAddress	getAddress () const
	Get the MIDI address. More...

void	setAddressUnsafe (MIDIAddress address)
	Set the MIDI address. More...

Public Attributes
Sender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

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.

◆ invert()

void invert ( )

inline

See also: AH::Button::invert()

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

◆ getButtonState()

AH::Button::State getButtonState ( ) const

inline

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

◆ getAddress()

MIDIAddress getAddress ( ) const

inline

Get the MIDI address.

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

◆ setAddressUnsafe()

void setAddressUnsafe ( MIDIAddress address )

inline

Set the MIDI address.

Has unexpected consequences if used while the push button is pressed. Use banks if you need to support that.

Definition at line 52 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/4]

void enable ( )

inlineinherited

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

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/4]

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

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

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/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 110 of file Updatable.hpp.

◆ disable() [2/4]

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

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

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.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

Member Data Documentation

◆ button

AH::Button button

private

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

◆ address

const MIDIAddress address

private

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

◆ sender

Sender sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 325 of file LinkedList.hpp.

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

Abstract/MIDIButton.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ MIDIButton()

Member Function Documentation

◆ begin()

◆ update()

◆ invert()

◆ getButtonState()

◆ getAddress()

◆ setAddressUnsafe()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ button

◆ address

◆ sender

◆ updatables

◆ next

◆ previous