ProgramChangeSelector< N > Class Template Reference

Selector that listens for MIDI Program Change events on a given MIDI Channel, and uses the program number as its selection. More...

#include <Selectors/ProgramChangeSelector.hpp>

Inheritance diagram for ProgramChangeSelector< N >:

Collaboration diagram for ProgramChangeSelector< N >:

Public Member Functions
	ProgramChangeSelector (Selectable< N > &selectable, const MIDICNChannel &address)
void	begin () override
	Initialize the input element. More...
void	reset () override
	Reset the input element to its initial state. More...
bool	updateImpl (const ChannelMessageMatcher &midimsg, const MIDICNChannelAddress &target) override
	Update the internal state with the new MIDI message. More...
void	update () override
	Update this updatable. More...
virtual void	update ()
	Update the value of the input element. Used for decaying VU meters etc. More...
void	set (setting_t newSetting)
	Select the given selection. More...
void	increment (Wrap wrap)
	Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...
void	decrement (Wrap wrap)
	Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...
setting_t	get () const
	Get the current selection/setting. More...
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
bool	isEnabled ()
	Check if this updatable is enabled. More...
bool	updateWith (const ChannelMessageMatcher &midimsg)
	Receive a new MIDI message and update the internal state. More...

Static Public Member Functions
static void	enable (Updatable *element)
static void	enable (Updatable &element)
static void	enable (U(&array)[N])
static void	disable (Updatable< NormalUpdatable > *element)
static void	disable (Updatable< NormalUpdatable > &element)
static void	disable (U(&array)[N])
static void	beginAll ()
	Begin all enabled instances of this class. More...
static void	beginAll ()
static void	updateAll ()
	Update all enabled instances of this class. More...
static void	updateAll ()
	Update all MIDIInputElementPC elements. More...
static void	resetAll ()
	Reset all MIDIInputElementPC elements to their initial state. More...
static void	updateAllWith (const ChannelMessageMatcher &midimsg)
	Update all MIDIInputElementPC elements with a new MIDI message. More...

Public Attributes
EmptySelectorCallback	callback

Protected Attributes
setting_t	setting = 0
	The selection of the selector. More...
Updatable< NormalUpdatable > *	next
MIDIInputElementPC *	next
Updatable< NormalUpdatable > *	previous
MIDIInputElementPC *	previous
const MIDICNChannelAddress	address

Private Member Functions
MIDICNChannelAddress	getTarget (const ChannelMessageMatcher &midimsg) const override
	Program Change doesn't have an address, so the target consists of just the channel and the cable number. More...
void	moveDown ()
	Move down this element in the linked list of elements. More...
virtual bool	match (const MIDICNChannelAddress &target) const
	Check if the address of the incoming MIDI message matches an address of this element. More...

Private Attributes
Selectable< N > &	selectable

Static Private Attributes
static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables
static DoublyLinkedList< MIDIInputElementPC >	elements

Detailed Description

template<setting_t N>
class ProgramChangeSelector< N >

Selector that listens for MIDI Program Change events on a given MIDI Channel, and uses the program number as its selection.

Template Parameters

N	The number of settings. The maximum program number is \( N - 1 \).

Definition at line 50 of file ProgramChangeSelector.hpp.

Constructor & Destructor Documentation

ProgramChangeSelector()

ProgramChangeSelector ( Selectable< N > &  selectable, const MIDICNChannel &  address  )

inline

Definition at line 52 of file ProgramChangeSelector.hpp.

Member Function Documentation

begin()

void begin ( )

inlineoverridevirtualinherited

Initialize the input element.

Reimplemented from MIDIInputElement.

Definition at line 18 of file ProgramChangeSelector.hpp.

reset()

void reset ( )

inlineoverridevirtualinherited

Reset the input element to its initial state.

Reimplemented from MIDIInputElement.

Definition at line 23 of file ProgramChangeSelector.hpp.

updateImpl()

bool updateImpl ( const ChannelMessageMatcher &  midimsg, const MIDICNChannelAddress &  target  )

inlineoverridevirtualinherited

Update the internal state with the new MIDI message.

Implements MIDIInputElement.

Definition at line 25 of file ProgramChangeSelector.hpp.

update() [1/2]

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 78 of file Selector.hpp.

update() [2/2]

virtual void update ( )

inlinevirtualinherited

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

Reimplemented in VU_Base< NumValues, Callback >, VU_Base< NumBanks, Callback >, VU_Base< NumBanks, VULEDsCallback< NumLEDs > >, VU_Base< NumBanks, VUEmptyCallback >, VU_Base< 1, VUEmptyCallback >, VU_Base< 1, VULEDsCallback< NumLEDs > >, and VU_Base< 1, Callback >.

Definition at line 36 of file MIDIInputElement.hpp.

set()

void set ( setting_t  newSetting )

inlineinherited

Select the given selection.

Parameters

newSetting

The new setting to select [0, N-1].

Definition at line 89 of file Selector.hpp.

increment()

void increment ( Wrap  wrap )

inlineinherited

Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.

Parameters

wrap	Wrap or clamp if the new setting would be out of range.

Definition at line 105 of file Selector.hpp.

decrement()

void decrement ( Wrap  wrap )

inlineinherited

Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.

Parameters

wrap	Wrap or clamp if the new setting would be out of range.

Definition at line 124 of file Selector.hpp.

get()

setting_t get ( ) const

inlineinherited

Get the current selection/setting.

Definition at line 47 of file Selector.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 45 of file Updatable.hpp.

enable() [2/4]

static void enable ( Updatable<> *  element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

enable() [3/4]

static void enable ( Updatable<> &  element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

enable() [4/4]

static void enable ( U(&)  array[N] )

inlinestaticinherited

Definition at line 90 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 55 of file Updatable.hpp.

disable() [2/4]

static void disable ( Updatable< NormalUpdatable<> > *  element )

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

disable() [3/4]

static void disable ( Updatable< NormalUpdatable<> > &  element )

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

disable() [4/4]

static void disable ( U(&)  array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

isEnabled()

bool isEnabled ( )

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 69 of file Updatable.hpp.

beginAll() [1/2]

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also

begin()

Definition at line 73 of file Updatable.hpp.

beginAll() [2/2]

static void beginAll ( )

inlinestaticinherited

Definition at line 37 of file MIDIInputElementPC.hpp.

updateAll() [1/2]

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also

update()

Definition at line 80 of file Updatable.hpp.

updateAll() [2/2]

static void updateAll ( )

inlinestaticinherited

Update all MIDIInputElementPC elements.

Definition at line 58 of file MIDIInputElementPC.hpp.

resetAll()

static void resetAll ( )

inlinestaticinherited

Reset all MIDIInputElementPC elements to their initial state.

See also

MIDIInputElementPC::reset

Definition at line 49 of file MIDIInputElementPC.hpp.

updateAllWith()

static void updateAllWith ( const ChannelMessageMatcher &  midimsg )

inlinestaticinherited

Update all MIDIInputElementPC elements with a new MIDI message.

See also

MIDIInputElementPC::updateWith

Definition at line 70 of file MIDIInputElementPC.hpp.

getTarget()

MIDICNChannelAddress getTarget ( const ChannelMessageMatcher &  midimsg ) const

inlineoverrideprivatevirtualinherited

Program Change doesn't have an address, so the target consists of just the channel and the cable number.

Reimplemented from MIDIInputElement.

Definition at line 85 of file MIDIInputElementPC.hpp.

moveDown()

void moveDown ( )

inlineprivateinherited

Move down this element in the linked list of elements.

This means that the element will be checked earlier on the next iteration.

Definition at line 95 of file MIDIInputElementPC.hpp.

updateWith()

bool updateWith ( const ChannelMessageMatcher &  midimsg )

inlineinherited

Receive a new MIDI message and update the internal state.

Definition at line 39 of file MIDIInputElement.hpp.

match()

virtual bool match ( const MIDICNChannelAddress &  target ) const

inlineprivatevirtualinherited

Check if the address of the incoming MIDI message matches an address of this element.

Note

This base version of the function is only valid for non-Bankable MIDI input elements, it only matches if the address is equal to the address of this element.

Reimplemented in GenericVU< NumBanks, Callback >, GenericVU< NumBanks >, GenericVU< NumBanks, VULEDsCallback< NumLEDs > >, GenericNoteCCRange< MIDIInputElementNote, 1, BankSize, NoteCCFastLEDCallback< ColorMapper > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, BankSize, NoteCCFastLEDCallback< ColorMapper > >, GenericNoteCCRange< MIDIInputElementNote, 1, BankSize, NoteCCLEDPWM< 1 > >, GenericNoteCCRange< MIDIInputElementCC, 1, BankSize, NoteCCLED< 1 > >, GenericNoteCCRange< MIDIInputElementCC, 1, BankSize, NoteCCFastLEDCallback< ColorMapper > >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, BankSize, NoteCCLEDPWM< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, BankSize, NoteCCLED< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, 1, BankSize, NoteCCLEDBarCallback< NumLEDs > >, GenericNoteCCRange< MIDIInputElementCC, 1, BankSize, NoteCCLEDPWM< 1 > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, BankSize, NoteCCLEDPWM< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, 1, BankSize, NoteCCLED< 1 > >, GenericNoteCCRange< MIDIInputElementCC, 1, BankSize, NoteCCLEDBarCallback< NumLEDs > >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, BankSize, NoteCCLED< RangeLen > >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, BankSize, NoteCCFastLEDCallback< ColorMapper > >, GenericVPotRing< NumBanks, Callback >, GenericVPotRing< NumBanks >, GenericVPotRing< NumBanks, VPotRingLEDsCallback >, GenericNoteCCRange< MIDIInputElementCC, 1, NoteCCFastLEDCallback< ColorMapper > >, GenericNoteCCRange< MIDIInputElementCC, 1, NoteCCLED< 1 > >, GenericNoteCCRange< MIDIInputElementNote, 1, NoteCCLED< 1 > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, NoteCCLED< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, NoteCCFastLEDCallback< ColorMapper > >, GenericNoteCCRange< MIDIInputElementNote, 1, NoteCCFastLEDCallback< ColorMapper > >, GenericNoteCCRange< MIDIInputElementNote, 1, NoteCCLEDPWM< 1 > >, GenericNoteCCRange< MIDIInputElementCC, 1, NoteCCLEDPWM< 1 > >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, NoteCCFastLEDCallback< ColorMapper > >, GenericNoteCCRange< MIDIInputElementCC, 1, NoteCCLEDBarCallback< NumLEDs > >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, NoteCCLED< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, NoteCCLEDPWM< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, 1, NoteCCLEDBarCallback< NumLEDs > >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, NoteCCLEDPWM< RangeLen > >, SevenSegmentDisplay< LENGTH >, SevenSegmentDisplay< AssignmentDisplayLength >, and SevenSegmentDisplay< TimeDisplayLength >.

Definition at line 75 of file MIDIInputElement.hpp.

Member Data Documentation

selectable

Selectable<N>& selectable

privateinherited

Definition at line 137 of file Selector.hpp.

callback

EmptySelectorCallback callback

inherited

Definition at line 140 of file Selector.hpp.

setting

setting_t setting = 0

protectedinherited

The selection of the selector.

It is saved in the selector as well as the selectable, because you need it in order to implement increment/decrement methods.

Definition at line 53 of file Selector.hpp.

updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

next [1/2]

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

next [2/2]

MIDIInputElementPC * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

previous [1/2]

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

previous [2/2]

MIDIInputElementPC * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

elements

DoublyLinkedList< MIDIInputElementPC > elements

staticprivateinherited

Definition at line 100 of file MIDIInputElementPC.hpp.

address

const MIDICNChannelAddress address

protectedinherited

Definition at line 80 of file MIDIInputElement.hpp.

---

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

• ProgramChangeSelector.hpp