Control Surface master
MIDI Control Surface library for Arduino
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
ProgramChangeSelectorLEDs< N > Class Template Referenceabstract

#include <Selectors/LEDs/SelectorLEDs.hpp>

Detailed Description

template<setting_t N>
class ProgramChangeSelectorLEDs< N >

Selector that listens for MIDI Program Change events on a given MIDI Channel, and uses the program number as its selection. This version displays the setting using LEDs.

Template Parameters
NThe number of settings. The maximum program number is \( N - 1 \).

Definition at line 179 of file SelectorLEDs.hpp.

+ Inheritance diagram for ProgramChangeSelectorLEDs< N >:
+ Collaboration diagram for ProgramChangeSelectorLEDs< N >:

Enabling and disabling updatables

void enable ()
 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 ()
 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
 Check if this updatable is enabled. More...
 
bool isEnabled () const
 Check if this updatable is enabled. More...
 
void moveDown ()
 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 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...
 
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...
 

Public Types

using Matcher = OneByteMIDIMatcher
 
using Parent = MatchingMIDIInputElement< MIDIMessageType::PROGRAM_CHANGE, Matcher >
 
using MessageType = typename MIDIInputElement< Type >::MessageType
 

Public Member Functions

 ProgramChangeSelectorLEDs (Selectable< N > &selectable, MIDIChannelCable address, const PinList< N > &ledPins)
 
void begin () override
 Initialize this updatable. More...
 
void reset () override
 Reset the input element to its initial state. More...
 
void handleUpdate (typename Matcher::Result match) override
 
virtual void handleUpdate (typename Matcher::Result match)=0
 
void update () override
 Update this updatable. More...
 
virtual void update ()
 Update the value of the input element. Used for decaying VU meters etc. More...
 
void set (setting_t newSetting)
 Select the given selection. More...
 
void increment (Wrap wrap)
 Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...
 
void decrement (Wrap wrap)
 Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...
 
setting_t get () const
 Get the current selection/setting. More...
 
bool updateWith (MessageType midimsg) override
 Receive a new MIDI message and update the internal state. More...
 

Static Public Member Functions

static void beginAll ()
 Begin all. More...
 
static void updateAll ()
 Update all. More...
 
static bool updateAllWith (MessageType midimsg)
 Update all. More...
 
static void resetAll ()
 Reset all. More...
 

Public Attributes

Callback callback
 

Protected Attributes

setting_t setting = 0
 The selection of the selector. More...
 
Node * next = nullptr
 
Node * next = nullptr
 
Node * previous = nullptr
 
Node * previous = nullptr
 
OneByteMIDIMatcher matcher
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 
static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Attributes

Selectable< N > & selectable
 

Member Typedef Documentation

◆ Matcher

using Matcher = OneByteMIDIMatcher
inherited

Definition at line 15 of file ProgramChangeSelector.hpp.

◆ Parent

Definition at line 16 of file ProgramChangeSelector.hpp.

◆ MessageType

using MessageType = typename MIDIInputElement<Type>::MessageType
inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ ProgramChangeSelectorLEDs()

ProgramChangeSelectorLEDs ( Selectable< N > &  selectable,
MIDIChannelCable  address,
const PinList< N > &  ledPins 
)
inline

Definition at line 182 of file SelectorLEDs.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Reimplemented from GenericSelector< N, Callback >.

Definition at line 25 of file ProgramChangeSelector.hpp.

◆ reset()

void reset ( )
inlineoverridevirtualinherited

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

Definition at line 27 of file ProgramChangeSelector.hpp.

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideinherited

Definition at line 29 of file ProgramChangeSelector.hpp.

◆ handleUpdate() [2/2]

virtual void handleUpdate ( typename Matcher::Result  match)
pure virtualinherited

◆ update() [1/2]

void update ( )
inlineoverridevirtualinherited

◆ update() [2/2]

virtual void update ( )
inlinevirtualinherited

Update the value of the input element. Used for decaying VU meters etc.

Reimplemented in VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, VU, and VU< BankSize >.

Definition at line 40 of file MIDIInputElement.hpp.

◆ set()

void set ( setting_t  newSetting)
inlineinherited

Select the given selection.

Parameters
newSettingThe new setting to select [0, N-1].

Definition at line 93 of file Selector.hpp.

◆ increment()

void increment ( Wrap  wrap)
inlineinherited

Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.

Parameters
wrapWrap or clamp if the new setting would be out of range.

Definition at line 109 of file Selector.hpp.

◆ decrement()

void decrement ( Wrap  wrap)
inlineinherited

Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.

Parameters
wrapWrap or clamp if the new setting would be out of range.

Definition at line 128 of file Selector.hpp.

◆ get()

setting_t get ( ) const
inlineinherited

Get the current selection/setting.

Definition at line 46 of file Selector.hpp.

◆ beginAll() [1/2]

static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 186 of file Updatable.hpp.

◆ beginAll() [2/2]

static void beginAll ( )
inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ updateAll() [1/2]

static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 190 of file Updatable.hpp.

◆ updateAll() [2/2]

static void updateAll ( )
inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ enable() [1/8]

void enable ( )
inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/8]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > *  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/8]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > &  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/8]

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 134 of file Updatable.hpp.

◆ enable() [5/8]

void enable ( )
inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 100 of file Updatable.hpp.

◆ enable() [6/8]

static void enable ( UpdatableCRTP< MIDIInputElement< Type > > *  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 129 of file Updatable.hpp.

◆ enable() [7/8]

static void enable ( UpdatableCRTP< MIDIInputElement< Type > > &  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 131 of file Updatable.hpp.

◆ enable() [8/8]

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 134 of file Updatable.hpp.

◆ disable() [1/8]

void disable ( )
inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 110 of file Updatable.hpp.

◆ disable() [2/8]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > *  element)
inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/8]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > &  element)
inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/8]

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 145 of file Updatable.hpp.

◆ disable() [5/8]

void disable ( )
inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 110 of file Updatable.hpp.

◆ disable() [6/8]

static void disable ( UpdatableCRTP< MIDIInputElement< Type > > *  element)
inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 140 of file Updatable.hpp.

◆ disable() [7/8]

static void disable ( UpdatableCRTP< MIDIInputElement< Type > > &  element)
inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 142 of file Updatable.hpp.

◆ disable() [8/8]

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 145 of file Updatable.hpp.

◆ isEnabled() [1/2]

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 124 of file Updatable.hpp.

◆ isEnabled() [2/2]

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 124 of file Updatable.hpp.

◆ moveDown() [1/2]

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

◆ moveDown() [2/2]

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

◆ updateWith()

bool updateWith ( MessageType  midimsg)
inlineoverridevirtualinherited

Receive a new MIDI message and update the internal state.

Implements MIDIInputElement< Type >.

Definition at line 95 of file MIDIInputElement.hpp.

◆ updateAllWith()

static bool updateAllWith ( MessageType  midimsg)
inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ resetAll()

static void resetAll ( )
inlinestaticinherited

Reset all.

Definition at line 67 of file MIDIInputElement.hpp.

Member Data Documentation

◆ selectable

Selectable<N>& selectable
privateinherited

Definition at line 141 of file Selector.hpp.

◆ callback

Callback callback
inherited

Definition at line 144 of file Selector.hpp.

◆ setting

setting_t setting = 0
protectedinherited

The selection of the selector.

It is saved in the selector as well as the selectable, because you need it in order to implement increment/decrement methods.

Definition at line 52 of file Selector.hpp.

◆ updatables [1/2]

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ updatables [2/2]

DoublyLinkedList< MIDIInputElement< Type > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next [1/2]

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ next [2/2]

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous [1/2]

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ previous [2/2]

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ matcher

OneByteMIDIMatcher matcher
protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.


The documentation for this class was generated from the following file: