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

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class.
static void	updateAll ()
	Update all enabled instances of this class.

Public Member Functions
	MIDIButton (pin_t pin, MIDIAddress address, const Sender &sender)
	Construct a new MIDIButton.
void	begin () override
	Initialize this updatable.
void	update () override
	Update this updatable.
void	invert ()
AH::Button::State	getButtonState () const
MIDIAddress	getAddress () const
	Get the MIDI address.
void	setAddressUnsafe (MIDIAddress address)
	Set the MIDI address.

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
MIDIAddress	address

Constructor & Destructor Documentation

MIDIButton()

template<class Sender>

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()

template<class Sender>

void begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

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

update()

template<class Sender>

void update ( )

inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

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

invert()

template<class Sender>

void invert ( )

inline

See also

invert()

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

getButtonState()

template<class Sender>

AH::Button::State getButtonState ( ) const

inline

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

getAddress()

template<class Sender>

MIDIAddress getAddress ( ) const

inline

Get the MIDI address.

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

setAddressUnsafe()

template<class Sender>

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()

template<class T = NormalUpdatable>

void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also

begin()

Definition at line 182 of file Updatable.hpp.

updateAll()

template<class T = NormalUpdatable>

void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also

update()

Definition at line 186 of file Updatable.hpp.

enable()

void enable ( )

inlineinherited

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

Definition at line 96 of file Updatable.hpp.

disable()

void disable ( )

inlineinherited

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

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

moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

button

template<class Sender>

AH::Button button

private

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

address

template<class Sender>

MIDIAddress address

private

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

sender

template<class Sender>

Sender sender

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

updatables

DoublyLinkedList<Updatable< NormalUpdatable >> updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

next

Updatable< NormalUpdatable >* next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

previous

Updatable< NormalUpdatable >* previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

---

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

• Abstract/MIDIButton.hpp