Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
PCButton Class Reference

#include <MIDI_Outputs/PCButton.hpp>

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.

+ Inheritance diagram for PCButton:
+ Collaboration diagram for PCButton:

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 (pin_t pin, MIDIAddress address)
 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
 
MIDIAddress getAddress () const
 Get the MIDI address.
 
void setAddressUnsafe (MIDIAddress address)
 Set the MIDI address.
 

Public Attributes

ProgramChangeSender sender
 

Protected Attributes

Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Private Attributes

AH::Button button
 
MIDIAddress address
 

Constructor & Destructor Documentation

◆ PCButton()

PCButton ( pin_t pin,
MIDIAddress address )
inline

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

Parameters
pinThe digital input pin to read from.
The internal pull-up resistor will be enabled.
addressThe MIDI address containing the program number [0, 127], channel [Channel_1, Channel_16], and optional cable number [Cable_1, Cable_16].

Definition at line 33 of file PCButton.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

◆ invert()

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

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

◆ getButtonState()

AH::Button::State getButtonState ( ) const
inlineinherited

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

◆ getAddress()

MIDIAddress getAddress ( ) const
inlineinherited

Get the MIDI address.

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

◆ setAddressUnsafe()

void setAddressUnsafe ( MIDIAddress address)
inlineinherited

Set the MIDI address.

Has unexpected consequences if used while the push button is pressed. Use banks if you need to support that.

Definition at line 52 of file 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

◆ button

AH::Button button
privateinherited

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

◆ address

MIDIAddress address
privateinherited

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

◆ sender

ProgramChangeSender sender
inherited

Definition at line 59 of file 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: