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 | List of all members
MIDIInputElement< Type > Class Template Referenceabstract

#include <MIDI_Inputs/MIDIInputElement.hpp>

Detailed Description

template<MIDIMessageType Type>
class MIDIInputElement< Type >

A class for objects that listen for incoming MIDI events.

They can either update some kind of display, or they can just save the state.

Definition at line 21 of file MIDIInputElement.hpp.

Inheritance diagram for MIDIInputElement< Type >:
Collaboration diagram for MIDIInputElement< Type >:

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.

Public Types

using MessageType

Public Member Functions

virtual ~MIDIInputElement ()=default
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.
virtual bool updateWith (MessageType midimsg)=0
 Receive a new MIDI message and update the internal state.

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

 MIDIInputElement ()=default

Protected Attributes

MIDIInputElement< Type > * next
MIDIInputElement< Type > * previous

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables

Member Typedef Documentation

◆ MessageType

template<MIDIMessageType Type>
using MessageType
Initial value:
typename std::conditional<Type == MIDIMessageType::SysExStart,
SysExMessage, ChannelMessage>::type
MIDIMessageType::SysExStart
@ SysExStart
Start of System Exclusive.
Definition MIDI_MessageTypes.hpp:34

Definition at line 29 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ MIDIInputElement()

template<MIDIMessageType Type>
MIDIInputElement ( )
protecteddefault

◆ ~MIDIInputElement()

template<MIDIMessageType Type>
virtual ~MIDIInputElement ( )
virtualdefault

Member Function Documentation

◆ begin()

template<MIDIMessageType Type>
virtual void begin ( )
inlinevirtual

Initialize the input element.

Reimplemented in NoteCCKPLED< Type, BankSize >, NoteCCKPLED< MIDIMessageType::ControlChange, BankSize >, NoteCCKPLED< MIDIMessageType::KeyPressure, BankSize >, NoteCCKPLED< MIDIMessageType::NoteOn, BankSize >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDBar< MIDIMessageType::ControlChange, BankSize, NumLEDs >, NoteCCKPLEDBar< MIDIMessageType::KeyPressure, BankSize, NumLEDs >, NoteCCKPLEDBar< MIDIMessageType::NoteOn, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPLEDPWM< MIDIMessageType::ControlChange, BankSize >, NoteCCKPLEDPWM< MIDIMessageType::KeyPressure, BankSize >, NoteCCKPLEDPWM< MIDIMessageType::NoteOn, BankSize >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::ControlChange, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::KeyPressure, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::NoteOn, BankSize, RangeLen, ColorMapper >, NoteCCKPRangeLEDs< Type, BankSize, RangeLen >, NoteCCKPRangeLEDs< MIDIMessageType::ControlChange, BankSize, RangeLen >, NoteCCKPRangeLEDs< MIDIMessageType::KeyPressure, BankSize, RangeLen >, NoteCCKPRangeLEDs< MIDIMessageType::NoteOn, BankSize, RangeLen >, GenericProgramChangeSelector< N, Callback >, GenericProgramChangeSelector< N, SelectorLEDsCallback< N > >, VPotRingLEDs< BankSize >, VULEDs< BankSize, NumLEDs >, LCD< BufferSize >, VPotRingLEDs, VULEDs< NumLEDs >, NoteCCKPLED< Type >, NoteCCKPLED< MIDIMessageType::ControlChange >, NoteCCKPLED< MIDIMessageType::KeyPressure >, NoteCCKPLED< MIDIMessageType::NoteOn >, NoteCCKPLEDBar< Type, NumLEDs >, NoteCCKPLEDBar< MIDIMessageType::ControlChange, NumLEDs >, NoteCCKPLEDBar< MIDIMessageType::KeyPressure, NumLEDs >, NoteCCKPLEDBar< MIDIMessageType::NoteOn, NumLEDs >, NoteCCKPLEDPWM< Type >, NoteCCKPLEDPWM< MIDIMessageType::ControlChange >, NoteCCKPLEDPWM< MIDIMessageType::KeyPressure >, NoteCCKPLEDPWM< MIDIMessageType::NoteOn >, NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::ControlChange, 1, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::ControlChange, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::KeyPressure, 1, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::KeyPressure, RangeLen, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::NoteOn, 1, ColorMapper >, NoteCCKPRangeFastLED< MIDIMessageType::NoteOn, RangeLen, ColorMapper >, NoteCCKPRangeLEDs< Type, RangeLen >, NoteCCKPRangeLEDs< MIDIMessageType::ControlChange, RangeLen >, NoteCCKPRangeLEDs< MIDIMessageType::KeyPressure, RangeLen >, and NoteCCKPRangeLEDs< MIDIMessageType::NoteOn, RangeLen >.

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

Reset the input element to its initial state.

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

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

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

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

Definition at line 40 of file MIDIInputElement.hpp.

◆ updateWith()

template<MIDIMessageType Type>
virtual bool updateWith ( MessageType midimsg)
pure virtual

Receive a new MIDI message and update the internal state.

Implemented in MatchingMIDIInputElement< Type, Matcher >, MatchingMIDIInputElement< MIDIMessageType::ChannelPressure, Matcher >, MatchingMIDIInputElement< MIDIMessageType::ChannelPressure, VUMatcher >, MatchingMIDIInputElement< MIDIMessageType::ControlChange, Matcher >, MatchingMIDIInputElement< MIDIMessageType::ControlChange, TwoByteRangeMIDIMatcher >, MatchingMIDIInputElement< MIDIMessageType::ControlChange, VPotMatcher >, MatchingMIDIInputElement< MIDIMessageType::PitchBend, PitchBendMIDIMatcher >, MatchingMIDIInputElement< MIDIMessageType::ProgramChange, Matcher >, MatchingMIDIInputElement< MIDIMessageType::ProgramChange, OneByteMIDIMatcher >, MatchingMIDIInputElement< Type, BankablePitchBendMIDIMatcher< BankSize > >, MatchingMIDIInputElement< Type, BankableTwoByteMIDIMatcher< BankSize > >, MatchingMIDIInputElement< Type, BankableTwoByteRangeMIDIMatcher< BankSize > >, MatchingMIDIInputElement< Type, BankableVPotMatcher< BankSize > >, MatchingMIDIInputElement< Type, BankableVUMatcher< BankSize > >, MatchingMIDIInputElement< Type, TwoByteMIDIMatcher >, and MatchingMIDIInputElement< Type, TwoByteRangeMIDIMatcher >.

◆ updateAllWith()

template<MIDIMessageType Type>
bool updateAllWith ( MessageType midimsg)
inlinestatic

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll()

template<MIDIMessageType Type>
void updateAll ( )
inlinestatic

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

template<MIDIMessageType Type>
void beginAll ( )
inlinestatic

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

template<MIDIMessageType Type>
void resetAll ( )
inlinestatic

Reset all.

Definition at line 67 of file MIDIInputElement.hpp.

◆ enable()

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.

◆ disable()

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.

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

Member Data Documentation

◆ updatables

DoublyLinkedList<MIDIInputElement< Type >> updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

MIDIInputElement< Type >* next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

MIDIInputElement< Type >* 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.17.0