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 Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

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

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
Sender	sender

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

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
AH::Button	button

const MIDIAddress	address

bool	state = false

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

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

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer 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 LockGuard &) const
	Check if this updatable is enabled. More...

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

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

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.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

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

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.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.