Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
GenericProgramChangeSelector< N, Callback > Class Template Referenceabstract

#include <Selectors/ProgramChangeSelector.hpp>

Detailed Description

template<setting_t N, class Callback = EmptySelectorCallback>
class GenericProgramChangeSelector< N, Callback >

Definition at line 10 of file ProgramChangeSelector.hpp.

+ Inheritance diagram for GenericProgramChangeSelector< N, Callback >:
+ Collaboration diagram for GenericProgramChangeSelector< N, Callback >:

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

using Matcher = OneByteMIDIMatcher
 
using Parent
 
using MessageType
 

Public Member Functions

 GenericProgramChangeSelector (Selectable< N > &selectable, const Callback &callback, MIDIChannelCable address)
 
void begin () override
 Initialize this updatable.
 
void reset () override
 Reset the input element to its initial state.
 
void handleUpdate (typename Matcher::Result match) override
 
void update () override
 Update this updatable.
 
void set (setting_t newSetting)
 Select the given selection.
 
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.
 
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.
 
setting_t get () const
 Get the current selection/setting.
 
bool updateWith (MessageType midimsg) override
 Receive a new MIDI message and update the internal state.
 
virtual void handleUpdate (typename Matcher::Result match)=0
 
virtual void update ()
 Update the value of the input element. Used for decaying VU meters etc.
 

Static Public Member Functions

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

Public Attributes

Callback callback
 

Protected Attributes

setting_t setting = 0
 The selection of the selector.
 
Derivednext
 
Derivedprevious
 
OneByteMIDIMatcher matcher
 
Nodenext = nullptr
 
Nodeprevious = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Derivedupdatables
 
static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Attributes

Selectable< N > & selectable
 

Member Typedef Documentation

◆ Matcher

template<setting_t N, class Callback = EmptySelectorCallback>
using Matcher = OneByteMIDIMatcher

Definition at line 15 of file ProgramChangeSelector.hpp.

◆ Parent

template<setting_t N, class Callback = EmptySelectorCallback>
using Parent
Initial value:
The MIDIInputElement base class is very general: you give it a MIDI message, and it calls the updateW...

Definition at line 16 of file ProgramChangeSelector.hpp.

◆ MessageType

using MessageType
inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ GenericProgramChangeSelector()

template<setting_t N, class Callback = EmptySelectorCallback>
GenericProgramChangeSelector ( Selectable< N > & selectable,
const Callback & callback,
MIDIChannelCable address )
inline

Definition at line 19 of file ProgramChangeSelector.hpp.

Member Function Documentation

◆ begin()

template<setting_t N, class Callback = EmptySelectorCallback>
void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 25 of file ProgramChangeSelector.hpp.

◆ reset()

template<setting_t N, class Callback = EmptySelectorCallback>
void reset ( )
inlineoverridevirtual

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

Definition at line 27 of file ProgramChangeSelector.hpp.

◆ handleUpdate() [1/2]

template<setting_t N, class Callback = EmptySelectorCallback>
void handleUpdate ( typename Matcher::Result match)
inlineoverride

Definition at line 29 of file ProgramChangeSelector.hpp.

◆ update() [1/2]

template<setting_t N, class Callback = EmptySelectorCallback>
void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Reimplemented in GenericSwitchSelector< Callback >, and GenericSwitchSelector< SelectorSingleLEDCallback >.

Definition at line 77 of file Selector.hpp.

◆ set()

template<setting_t N, class Callback = EmptySelectorCallback>
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()

template<setting_t N, class Callback = EmptySelectorCallback>
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()

template<setting_t N, class Callback = EmptySelectorCallback>
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]

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() [1/2]

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/8]

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/8]

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/8]

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/8]

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/8]

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/8]

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/8]

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/8]

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() [1/2]

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() [1/2]

template<class Derived >
void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 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.

◆ handleUpdate() [2/2]

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

◆ update() [2/2]

template<MIDIMessageType Type>
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.

◆ updateAllWith()

template<MIDIMessageType Type>
static bool updateAllWith ( MessageType midimsg)
inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll() [2/2]

template<MIDIMessageType Type>
static void updateAll ( )
inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll() [2/2]

template<MIDIMessageType Type>
static void beginAll ( )
inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

template<MIDIMessageType Type>
static void resetAll ( )
inlinestaticinherited

Reset all.

Definition at line 67 of file MIDIInputElement.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 96 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 125 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 127 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 130 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 106 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 136 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 138 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 141 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 120 of file Updatable.hpp.

◆ moveDown() [2/2]

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ selectable

template<setting_t N, class Callback = EmptySelectorCallback>
Selectable<N>& selectable
privateinherited

Definition at line 141 of file Selector.hpp.

◆ callback

template<setting_t N, class Callback = EmptySelectorCallback>
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]

template<class Derived >
DoublyLinkedList< Derived > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next [1/2]

Derived * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous [1/2]

Derived * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ matcher

OneByteMIDIMatcher matcher
protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables [2/2]

DoublyLinkedList< MIDIInputElement< Type > > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next [2/2]

template<class Node >
Node* next = nullptr
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous [2/2]

template<class Node >
Node* previous = nullptr
protectedinherited

Definition at line 321 of file LinkedList.hpp.


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