PCButton Class Reference

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/PCButton.hpp>

Inheritance diagram for PCButton:

Collaboration diagram for PCButton:

Public Member Functions
	PCButton (pin_t pin, const MIDICNChannelAddress &address, const ProgramChangeSender &sender={})
	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
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
ProgramChangeSender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next
Updatable< NormalUpdatable > *	previous

Private Attributes
AH::Button	button
const MIDICNChannelAddress	address

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

Detailed Description

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 cannot be banked.

Examples

PCButton.ino.

Definition at line 19 of file PCButton.hpp.

Constructor & Destructor Documentation

PCButton()

PCButton ( pin_t  pin, const MIDICNChannelAddress &  address, const ProgramChangeSender &  sender = {}  )

inline

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

Parameters

pin	The digital input pin to read from. The internal pull-up resistor will be enabled.
address	The MIDI address containing the program number [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
sender	The MIDI sender to use.

Definition at line 35 of file PCButton.hpp.

Member Function Documentation

begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 35 of file Abstract/MIDIButton.hpp.

invert()

void invert ( )

inlineinherited

Definition at line 45 of file Abstract/MIDIButton.hpp.

getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

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

privateinherited

Definition at line 51 of file Abstract/MIDIButton.hpp.

address

const MIDICNChannelAddress address

privateinherited

Definition at line 52 of file Abstract/MIDIButton.hpp.

sender

ProgramChangeSender sender

inherited

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

• PCButton.hpp