MIDIInputElement< Type > Class Template Reference

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

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
Node *	next = nullptr
Node *	previous = nullptr

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

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 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 >, LCD< BufferSize >, 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 ( )

inlinevirtual

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

inlinevirtual

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.

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, VUMatcher >, MatchingMIDIInputElement< MIDIMessageType::ControlChange, TwoByteRangeMIDIMatcher >, MatchingMIDIInputElement< MIDIMessageType::ControlChange, VPotMatcher >, MatchingMIDIInputElement< MIDIMessageType::PitchBend, PitchBendMIDIMatcher >, 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>

static bool updateAllWith ( MessageType midimsg )

inlinestatic

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

updateAll()

template<MIDIMessageType Type>

static void updateAll ( )

inlinestatic

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

beginAll()

template<MIDIMessageType Type>

static void beginAll ( )

inlinestatic

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

resetAll()

template<MIDIMessageType Type>

static void resetAll ( )

inlinestatic

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.

Member Data Documentation

updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

next

template<class Node >

Node* next = nullptr

protectedinherited

Definition at line 320 of file LinkedList.hpp.

previous

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:

• MIDIInputElement.hpp