#include <MIDI_Inputs/NoteCCKPValue.hpp>

Detailed Description

template<MIDIMessageType Type>
class NoteCCKPValue< Type >

Generic base class for classes that listen for MIDI Note, Control Change and Key Pressure events on a single address and save their value.

Template Parameters

Type	The type of MIDI messages to listen for: MIDIMessageType::NoteOn MIDIMessageType::ControlChange MIDIMessageType::KeyPressure

Examples: MCU-OLED-SSD1306-x2.ino, MCU-OLED-SSD1306.ino, and VU-Meter-Bridge.ino.

Definition at line 19 of file NoteCCKPValue.hpp.

Inheritance diagram for NoteCCKPValue< Type >:

Collaboration diagram for NoteCCKPValue< Type >:

Data access
uint8_t	getValue () const override
	Get the most recent MIDI value that was received.

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.

Detecting changes
bool	getDirty () const
	Check if the value was updated since the last time the dirty flag was cleared.

void	clearDirty ()
	Clear the dirty flag.

Public Types
using	Matcher = TwoByteMIDIMatcher

using	MessageType

Public Member Functions
	NoteCCKPValue (MIDIAddress address)

void	reset () override
	Reset all values to zero.

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	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
bool	handleUpdateImpl (typename Matcher::Result match)

void	handleUpdate (typename Matcher::Result match) override

Protected Attributes
TwoByteMIDIMatcher	matcher

Node *	next = nullptr

Node *	previous = nullptr

bool	dirty = true

Static Protected Attributes
static DoublyLinkedList< MIDIInputElement< Type > >	updatables

Private Attributes
uint8_t	value = 0

Member Typedef Documentation

◆ Matcher

template<MIDIMessageType Type>

using Matcher = TwoByteMIDIMatcher

Definition at line 22 of file NoteCCKPValue.hpp.

◆ MessageType

using MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ NoteCCKPValue()

template<MIDIMessageType Type>

NoteCCKPValue ( MIDIAddress address )

inline

Parameters

address The address to listen to.

Definition at line 26 of file NoteCCKPValue.hpp.

Member Function Documentation

◆ handleUpdateImpl()

template<MIDIMessageType Type>

bool handleUpdateImpl ( typename Matcher::Result match )

inlineprotected

Definition at line 30 of file NoteCCKPValue.hpp.

◆ handleUpdate() [1/2]

template<MIDIMessageType Type>

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotected

Definition at line 36 of file NoteCCKPValue.hpp.

◆ getValue()

template<MIDIMessageType Type>

uint8_t getValue ( ) const

inlineoverridevirtual

Get the most recent MIDI value that was received.

Implements IValue.

Definition at line 45 of file NoteCCKPValue.hpp.

◆ reset()

template<MIDIMessageType Type>

void reset ( )

inlineoverridevirtual

Reset all values to zero.

Reimplemented from MIDIInputElement< Type >.

Definition at line 50 of file NoteCCKPValue.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

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

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

◆ getDirty()

bool getDirty ( ) const

inlineinherited

Check if the value was updated since the last time the dirty flag was cleared.

Definition at line 19 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )

inlineinherited

Clear the dirty flag.

Definition at line 21 of file InterfaceMIDIInputElements.hpp.

Member Data Documentation

◆ value

template<MIDIMessageType Type>

uint8_t value = 0

private

Definition at line 56 of file NoteCCKPValue.hpp.

◆ matcher

TwoByteMIDIMatcher 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

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.

◆ dirty

bool dirty = true

protectedinherited

Definition at line 28 of file InterfaceMIDIInputElements.hpp.

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

NoteCCKPValue.hpp

Detailed Description

Data access

Enabling and disabling updatables

Detecting changes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Member Typedef Documentation

◆ Matcher

◆ MessageType

Constructor & Destructor Documentation

◆ NoteCCKPValue()

Member Function Documentation

◆ handleUpdateImpl()

◆ handleUpdate() [1/2]

◆ getValue()

◆ reset()

◆ updateWith()

◆ handleUpdate() [2/2]

◆ begin()

◆ update()

◆ updateAllWith()

◆ updateAll()

◆ beginAll()

◆ resetAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

◆ getDirty()

◆ clearDirty()

Member Data Documentation

◆ value

◆ matcher

◆ updatables

◆ next

◆ previous

◆ dirty