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

#include <MIDIButton.hpp>

Inheritance diagram for MIDIButton< Sender >:

Collaboration diagram for MIDIButton< Sender >:

Public Member Functions
	MIDIButton (pin_t pin, const MIDICNChannelAddress &address, const Sender &sender)
	Construct a new MIDIButton. More...

void	begin () override
	Initialize this updatable. More...

void	update () override
	Update this updatable. More...

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)

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 Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
AH::Button	button

const MIDICNChannelAddress	address

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

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

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

Constructor & Destructor Documentation

◆ MIDIButton()

template<class Sender>

MIDIButton< Sender >::MIDIButton	(	pin_t	pin,
		const MIDICNChannelAddress &	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 MIDIButton< Sender >::begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements AH::Updatable<>.

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

◆ update()

template<class Sender>

void MIDIButton< Sender >::update ( )

inlineoverridevirtual

Update this updatable.

Implements AH::Updatable<>.

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

◆ getButtonState()

template<class Sender>

AH::Button::State MIDIButton< Sender >::getButtonState ( ) const

inline

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

◆ enable() [1/4]

void AH::Updatable< NormalUpdatable >::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 AH::Updatable< NormalUpdatable >::enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

static void AH::Updatable< NormalUpdatable >::enable ( Updatable<> & element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

static void AH::Updatable< NormalUpdatable >::enable ( U(&) array[N] )

inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [1/4]

void AH::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 55 of file Updatable.hpp.

◆ disable() [2/4]

static void AH::Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > * element )

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

static void AH::Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > & element )

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

static void AH::Updatable< NormalUpdatable >::disable ( U(&) array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

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

◆ beginAll()

static void AH::Updatable< NormalUpdatable >::beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

static void AH::Updatable< NormalUpdatable >::updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ button

template<class Sender>

AH::Button MIDIButton< Sender >::button

private

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

◆ address

template<class Sender>

const MIDICNChannelAddress MIDIButton< Sender >::address

private

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

◆ sender

template<class Sender>

Sender MIDIButton< Sender >::sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > AH::Updatable< NormalUpdatable >::updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

Abstract/MIDIButton.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

template<class Sender> class MIDIButton< Sender >

Constructor & Destructor Documentation

◆ MIDIButton()

Member Function Documentation

◆ begin()

◆ update()

◆ getButtonState()

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

◆ beginAll()

◆ updateAll()

Member Data Documentation

◆ button

◆ address

◆ sender

◆ updatables

◆ next

◆ previous

template<class Sender>
class MIDIButton< Sender >