A class of MIDIOutputElements that read the input of a momentary push button or switch, and send out MIDI Program Change events. More...

#include <MIDI_Outputs/ManyAddresses/PCButton.hpp>

Inheritance diagram for PCButton< NumBanks >:

Collaboration diagram for PCButton< NumBanks >:

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
	PCButton (const Bank< NumBanks > &bank, pin_t pin, const Array< MIDIAddress, NumBanks > &addresses)
	Create a new PCButton object with the given pin, program number and channel. More...

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

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

void	invert ()

AH::Button::State	getButtonState () const

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
ProgramChangeSender	sender

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

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

static Mutex	mutex

Private Attributes
ManyAddresses< NumBanks >	address

AH::Button	button

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<setting_t NumBanks>
class Bankable::ManyAddresses::PCButton< NumBanks >

A class of MIDIOutputElements that read the input of a momentary push button or switch, and send out MIDI Program Change events.

A Program Change event is sent when the button is pressed.
The button is debounced in software.
This version can be banked using an arbitrary list of alternative addresses.

Template Parameters

NumBanks The number of variants/alternative addresses the element has.

Examples: ManyAddressesPCButton.ino.

Definition at line 28 of file ManyAddresses/PCButton.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

◆ PCButton()

PCButton	(	const Bank< NumBanks > &	bank,
		pin_t	pin,
		const Array< MIDIAddress, NumBanks > &	addresses
	)

inline

Create a new PCButton object with the given pin, program number and channel.

Parameters

bank	The bank that selects the address to use.
pin	The digital input pin to read from. The internal pull-up resistor will be enabled.
addresses	The list of MIDI addresses containing the program number [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16].

Definition at line 45 of file ManyAddresses/PCButton.hpp.

Member Function Documentation

◆ begin()

void begin

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

Definition at line 36 of file Bankable/Abstract/MIDIButton.hpp.

◆ update()

void update

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 37 of file Bankable/Abstract/MIDIButton.hpp.

◆ invert()

void invert

inlineinherited

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

◆ getButtonState()

AH::Button::State getButtonState

inlineinherited

Definition at line 52 of file Bankable/Abstract/MIDIButton.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.