#include <MIDI_Inputs/NoteCCKPRange.hpp>

Detailed Description

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>
class Bankable::NoteCCKPRange< Type, BankSize, RangeLen >

Generic base class for classes that listen for MIDI Note, Control Change and Key Pressure events on a range of addresses and save their values.

This version listens for the range over different banks.

Template Parameters

Type	The type of MIDI messages to listen for: MIDIMessageType::NoteOn MIDIMessageType::ControlChange MIDIMessageType::KeyPressure
BankSize	The number of banks.
RangeLen	The length of the range of addresses to listen to.

Definition at line 109 of file NoteCCKPRange.hpp.

Inheritance diagram for NoteCCKPRange< Type, BankSize, RangeLen >:

Collaboration diagram for NoteCCKPRange< Type, BankSize, RangeLen >:

Data access
uint8_t	getValue (uint8_t index) const
	Get the most recent MIDI value that was received for the active bank.

uint8_t	getValue (uint8_t bank, uint8_t index) const
	Get the most recent MIDI value that was received for the given bank.

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.

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	Matcher = BankableTwoByteRangeMIDIMatcher<BankSize>

using	MessageType = typename MIDIInputElement<Type>::MessageType

Public Member Functions
	NoteCCKPRange (BankConfig< BankSize > config, 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

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

uint8_t	getActiveBank () const

Protected Attributes
bool	dirty = true

Matcher	matcher

Node *	next = nullptr

BankSettingChangeCallback *	next

Node *	previous = nullptr

BankSettingChangeCallback *	previous

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

Private Attributes
AH::Array2D< uint8_t, BankSize, RangeLen >	values = {{{}}}

Member Typedef Documentation

◆ Matcher

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

using Matcher = BankableTwoByteRangeMIDIMatcher<BankSize>

Definition at line 112 of file NoteCCKPRange.hpp.

◆ MessageType

template<MIDIMessageType Type, class Matcher >

using MessageType = typename MIDIInputElement<Type>::MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ NoteCCKPRange()

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

NoteCCKPRange	(	BankConfig< BankSize >	config,
		MIDIAddress	address )

inline

Parameters

config	The bank configuration to use.
address	The base address to listen to.

Definition at line 118 of file NoteCCKPRange.hpp.

Member Function Documentation

◆ handleUpdateImpl()

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

bool handleUpdateImpl ( typename Matcher::Result match )

inlineprotected

Definition at line 123 of file NoteCCKPRange.hpp.

◆ handleUpdate() [1/2]

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotected

Definition at line 131 of file NoteCCKPRange.hpp.

◆ getValue() [1/2]

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

uint8_t getValue ( uint8_t index ) const

inline

Get the most recent MIDI value that was received for the active bank.

Definition at line 140 of file NoteCCKPRange.hpp.

◆ getValue() [2/2]

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

uint8_t getValue	(	uint8_t	bank,
		uint8_t	index ) const

inline

Get the most recent MIDI value that was received for the given bank.

Definition at line 144 of file NoteCCKPRange.hpp.

◆ reset()

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

void reset ( )

inlineoverridevirtual

Reset all values to zero.

Reimplemented from MIDIInputElement< Type >.

Reimplemented in NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, and NoteCCKPRangeLEDs< Type, BankSize, RangeLen >.

Definition at line 151 of file NoteCCKPRange.hpp.

◆ getDirty()

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

bool getDirty ( ) const

inline

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

Definition at line 161 of file NoteCCKPRange.hpp.

◆ clearDirty()

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

void clearDirty ( )

inline

Clear the dirty flag.

Definition at line 163 of file NoteCCKPRange.hpp.

◆ onBankSettingChange()

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

void onBankSettingChange ( )

inlineoverrideprotectedvirtual

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

Reimplemented in NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, and NoteCCKPRangeLEDs< Type, BankSize, RangeLen >.

Definition at line 168 of file NoteCCKPRange.hpp.

◆ getActiveBank()

uint8_t getActiveBank ( ) const

inlineprotectedinherited

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

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

Member Data Documentation

◆ values

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

AH::Array2D<uint8_t, BankSize, RangeLen> values = {{{}}}

private

Definition at line 171 of file NoteCCKPRange.hpp.

◆ dirty

template<MIDIMessageType Type, uint8_t BankSize, uint8_t RangeLen>

bool dirty = true

protected

Definition at line 174 of file NoteCCKPRange.hpp.

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

◆ next [2/2]

BankSettingChangeCallback * next

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.

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

NoteCCKPRange.hpp

Detailed Description

Data access

Detecting changes

Enabling and disabling updatables

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

◆ NoteCCKPRange()

Member Function Documentation

◆ handleUpdateImpl()

◆ handleUpdate() [1/2]

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ reset()

◆ getDirty()

◆ clearDirty()

◆ onBankSettingChange()

◆ getActiveBank()

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

Member Data Documentation

◆ values

◆ dirty

◆ matcher

◆ updatables

◆ next [1/2]

◆ next [2/2]

◆ previous [1/2]

◆ previous [2/2]