#include <MIDI_Outputs/Abstract/MIDIButtonLatched.hpp>

Detailed Description

template<class Sender>
class MIDIButtonLatched< Sender >

A class for momentary buttons and switches that send MIDI events.

The button is debounced, and the button is latched (press once to enable, press again to disable) (toggle).

See also: Button

Definition at line 20 of file Abstract/MIDIButtonLatched.hpp.

Inheritance diagram for MIDIButtonLatched< Sender >:

Collaboration diagram for MIDIButtonLatched< 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.

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

template<class U , size_t N>
static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

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

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

template<class U , size_t N>
static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

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
void	begin () final override
	Initialize this updatable.

void	update () final override
	Update this updatable.

bool	toggleState ()
	Flip the state (on → off or off → on).

bool	getState () const
	Get the current state.

void	setState (bool state)
	Set the state to the given value.

void	invert ()

AH::Button::State	getButtonState () const
	Get the state of the underlying button.

MIDIAddress	getAddress () const
	Get the MIDI address.

void	setAddressUnsafe (MIDIAddress address)
	Set the MIDI address.

Public Attributes
Sender	sender

Protected Member Functions
	MIDIButtonLatched (pin_t pin, MIDIAddress address, const Sender &sender)
	Create a new MIDIButtonLatched object on the given pin and address.

Protected Attributes
Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Private Attributes
AH::Button	button

MIDIAddress	address

bool	state = false

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

template<class Sender >

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

inlineprotected

Create a new MIDIButtonLatched object on the given pin and address.

Parameters

pin	The digital input pin to read from. The internal pull-up resistor will be enabled.
address	The MIDI address to send to.
sender	The MIDI sender to use.

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

Member Function Documentation

◆ begin()

template<class Sender >

void begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 38 of file Abstract/MIDIButtonLatched.hpp.

◆ update()

template<class Sender >

void update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 39 of file Abstract/MIDIButtonLatched.hpp.

◆ toggleState()

template<class Sender >

bool toggleState ( )

inline

Flip the state (on → off or off → on).

Sends the appropriate MIDI event.

Definition at line 47 of file Abstract/MIDIButtonLatched.hpp.

◆ getState()

template<class Sender >

bool getState ( ) const

inline

Get the current state.

Definition at line 53 of file Abstract/MIDIButtonLatched.hpp.

◆ setState()

template<class Sender >

void setState ( bool state )

inline

Set the state to the given value.

Sends the appropriate MIDI event.

Definition at line 57 of file Abstract/MIDIButtonLatched.hpp.

◆ invert()

template<class Sender >

void invert ( )

inline

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

Definition at line 63 of file Abstract/MIDIButtonLatched.hpp.

◆ getButtonState()

template<class Sender >

AH::Button::State getButtonState ( ) const

inline

Get the state of the underlying button.

Definition at line 66 of file Abstract/MIDIButtonLatched.hpp.

◆ getAddress()

template<class Sender >

MIDIAddress getAddress ( ) const

inline

Get the MIDI address.

Definition at line 69 of file Abstract/MIDIButtonLatched.hpp.

◆ setAddressUnsafe()

template<class Sender >

void setAddressUnsafe ( MIDIAddress address )

inline

Set the MIDI address.

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

Definition at line 72 of file Abstract/MIDIButtonLatched.hpp.

◆ beginAll()

template<class T = NormalUpdatable>

static 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>

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >

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.

◆ enable() [2/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

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

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

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

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

template<class Derived >

template<class U , size_t N>

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

◆ disable() [1/4]

template<class Derived >

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.

◆ disable() [2/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

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

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

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

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

template<class Derived >

template<class U , size_t N>

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

◆ isEnabled()

template<class Derived >

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

template<class Derived >

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 75 of file Abstract/MIDIButtonLatched.hpp.

◆ address

template<class Sender >

MIDIAddress address

private

Definition at line 76 of file Abstract/MIDIButtonLatched.hpp.

◆ state

template<class Sender >

bool state = false

private

Definition at line 77 of file Abstract/MIDIButtonLatched.hpp.

◆ sender

template<class Sender >

Sender sender

Definition at line 80 of file Abstract/MIDIButtonLatched.hpp.

◆ updatables

template<class Derived >

DoublyLinkedList< Derived > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

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

Abstract/MIDIButtonLatched.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

Member Function Documentation

◆ begin()

◆ update()

◆ toggleState()

◆ getState()

◆ setState()

◆ 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

◆ state

◆ sender

◆ updatables

◆ next

◆ previous