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

#include <MIDI_Outputs/Abstract/MIDIButtonLatched.hpp>

Inheritance diagram for MIDIButtonLatched< Sender >:

Collaboration diagram for MIDIButtonLatched< Sender >:

Public Member Functions
void	begin () final override
	Initialize this updatable. More...

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

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

bool	getState () const
	Get the current state. More...

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

void	invert ()

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

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 Member Functions
	MIDIButtonLatched (pin_t pin, const MIDICNChannelAddress &address, const Sender &sender)
	Create a new MIDIButtonLatched object on the given pin and address. More...

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
AH::Button	button

const MIDICNChannelAddress	address

bool	state = false

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

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.

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

MIDIButtonLatched	(	pin_t	pin,
		const MIDICNChannelAddress &	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()

void begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

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

◆ toggleState()

bool toggleState ( )

inline

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

Sends the appropriate MIDI event.

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

◆ getState()

bool getState ( ) const

inline

Get the current state.

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

◆ setState()

void setState ( bool state )

inline

Set the state to the given value.

Sends the appropriate MIDI event.

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

◆ invert()

void invert ( )

inline

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

◆ getButtonState()

AH::Button::State getButtonState ( ) const

inline

Get the state of the underlying button.

Definition at line 68 of file Abstract/MIDIButtonLatched.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 45 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( Updatable<> & element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

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

◆ disable() [2/4]

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

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

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

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

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

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ button

AH::Button button

private

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

◆ address

const MIDICNChannelAddress address

private

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

◆ state

bool state = false

private

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

◆ sender

Sender sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

Abstract/MIDIButtonLatched.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

template<class Sender> class MIDIButtonLatched< Sender >

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

Member Function Documentation

◆ begin()

◆ update()

◆ toggleState()

◆ getState()

◆ setState()

◆ invert()

◆ 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

◆ state

◆ sender

◆ updatables

◆ next

◆ previous

template<class Sender>
class MIDIButtonLatched< Sender >