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

#include <MIDI_Inputs/MIDIInputElement.hpp>

Detailed Description

template<MIDIMessageType Type, class Matcher>
class BankableMatchingMIDIInputElement< Type, Matcher >

Similar to MatchingMIDIInputElement, but for Bankable MIDI Input Elements.

Definition at line 113 of file MIDIInputElement.hpp.

+ Inheritance diagram for BankableMatchingMIDIInputElement< Type, Matcher >:
+ Collaboration diagram for BankableMatchingMIDIInputElement< Type, Matcher >:

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

Public Types

using MessageType = typename MIDIInputElement<Type>::MessageType
 

Public Member Functions

virtual ~BankableMatchingMIDIInputElement ()
 Destructor: remove element from the bank.
 
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 begin ()
 Initialize the input element.
 
virtual void reset ()
 Reset the input element to its initial state.
 
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.
 

Protected Member Functions

 BankableMatchingMIDIInputElement (const Matcher &matcher)
 Create a new BankableMatchingMIDIInputElement object, and add it to the bank.
 
uint8_t getActiveBank () const
 

Protected Attributes

Matcher matcher
 
Node * next = nullptr
 
Node * previous = nullptr
 
BankSettingChangeCallback * next
 
BankSettingChangeCallback * previous
 

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Member Functions

virtual void onBankSettingChange ()
 A function to be executed each time the bank setting changes.
 

Member Typedef Documentation

◆ MessageType

template<MIDIMessageType Type, class Matcher >
using MessageType = typename MIDIInputElement<Type>::MessageType
inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ BankableMatchingMIDIInputElement()

template<MIDIMessageType Type, class Matcher >
BankableMatchingMIDIInputElement ( const Matcher & matcher)
inlineprotected

Create a new BankableMatchingMIDIInputElement object, and add it to the bank.

Definition at line 121 of file MIDIInputElement.hpp.

◆ ~BankableMatchingMIDIInputElement()

template<MIDIMessageType Type, class Matcher >
virtual ~BankableMatchingMIDIInputElement ( )
inlinevirtual

Destructor: remove element from the bank.

Definition at line 130 of file MIDIInputElement.hpp.

Member Function Documentation

◆ getActiveBank()

template<MIDIMessageType Type, class Matcher >
uint8_t getActiveBank ( ) const
inlineprotected

Definition at line 126 of file MIDIInputElement.hpp.

◆ updateWith()

template<MIDIMessageType Type, class Matcher >
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()

template<MIDIMessageType Type, class Matcher >
virtual void handleUpdate ( typename Matcher::Result match)
pure virtualinherited

Implemented in VPotRingLEDs< BankSize >, VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, and NoteCCKPRangeLEDs< Type, BankSize, RangeLen >.

Examples
Custom-MIDI-Input-Element.ino, Custom-Note-LED-Input-Element-Callback-FastLED.ino, and Custom-Note-LED-Input-Element-Callback.ino.

◆ begin()

template<MIDIMessageType Type>
virtual void begin ( )
inlinevirtualinherited

Initialize the input element.

Reimplemented in VPotRingLEDs, VPotRingLEDs< BankSize >, VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, NumLEDs >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeLEDs< Type, RangeLen >, NoteCCKPRangeLEDs< Type, BankSize, RangeLen >, GenericProgramChangeSelector< N, Callback >, and GenericProgramChangeSelector< N, SelectorLEDsCallback< N > >.

Examples
Custom-MIDI-Input-Element.ino, Custom-Note-LED-Input-Element-Callback-FastLED.ino, and Custom-Note-LED-Input-Element-Callback.ino.

Definition at line 34 of file MIDIInputElement.hpp.

◆ reset()

template<MIDIMessageType Type>
virtual void reset ( )
inlinevirtualinherited

Reset the input element to its initial state.

Reimplemented in VPotRingLEDs, VPotRingLEDs< BankSize >, VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, NumLEDs >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeLEDs< Type, RangeLen >, NoteCCKPRangeLEDs< Type, BankSize, RangeLen >, SevenSegmentDisplay< LENGTH >, SevenSegmentDisplay< AssignmentDisplayLength >, SevenSegmentDisplay< TimeDisplayLength >, VPotRing, VPotRing< BankSize >, VU, VU< BankSize >, NoteCCKPRange< Type, RangeLen >, NoteCCKPRange< Type, BankSize, RangeLen >, NoteCCKPValue< Type >, NoteCCKPValue< Type, BankSize >, PBValue, PBValue< BankSize >, GenericProgramChangeSelector< N, Callback >, and GenericProgramChangeSelector< N, SelectorLEDsCallback< N > >.

Examples
Custom-MIDI-Input-Element.ino, and Custom-Note-LED-Input-Element-Callback.ino.

Definition at line 37 of file MIDIInputElement.hpp.

◆ update()

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()

template<MIDIMessageType Type>
static void updateAll ( )
inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

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

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]

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() [3/4]

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

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]

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]

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() [3/4]

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

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()

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()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

◆ onBankSettingChange()

virtual void onBankSettingChange ( )
inlineprivatevirtualinherited

A function to be executed each time the bank setting changes.

Think of an LED that indicates whether a track is muted or not. If this LED is bankable, let's say with 4 tracks per bank, 2 banks, and a base address of 3, then this LED object keeps the state of tracks 3 and 7. When the bank setting is 0, the LED displays the state of track 3, when the bank setting is 1, the LED displays the state of track 7. To know when to update the LED, this callback is used.

Reimplemented in VPotRingLEDs< BankSize >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeLEDs< Type, BankSize, RangeLen >, VPotRing< BankSize >, VU< BankSize >, NoteCCKPRange< Type, BankSize, RangeLen >, NoteCCKPValue< Type, BankSize >, and PBValue< BankSize >.

Definition at line 81 of file Bank.hpp.

Member Data Documentation

◆ matcher

template<MIDIMessageType Type, class Matcher >
Matcher matcher
protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next [1/2]

template<class Node >
Node* next = nullptr
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous [1/2]

template<class Node >
Node* previous = nullptr
protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ next [2/2]

BankSettingChangeCallback * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous [2/2]

BankSettingChangeCallback * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0