#include <MIDI_Outputs/ManyAddresses/PCButton.hpp>

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.

Inheritance diagram for PCButton< NumBanks >:

Collaboration diagram for PCButton< NumBanks >:

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

void	begin () override
	Initialize this updatable.

void	update () override
	Update this updatable.

void	invert ()

AH::Button::State	getButtonState () const

Public Attributes
ProgramChangeSender	sender

Protected Attributes
ManyAddresses< NumBanks >	address

AH::Button	button

Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Constructor & Destructor Documentation

◆ PCButton()

template<setting_t NumBanks>

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

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

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

◆ invert()

void invert ( )

inlineinherited

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

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

◆ getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

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

◆ address

ManyAddresses< NumBanks > address

protectedinherited

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

◆ button

AH::Button button

protectedinherited

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

◆ sender

ProgramChangeSender sender

inherited

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

ManyAddresses/PCButton.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ PCButton()

Member Function Documentation

◆ begin()

◆ update()

◆ invert()

◆ getButtonState()

◆ 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

◆ address

◆ button

◆ sender

◆ updatables

◆ next

◆ previous