#include <Selectors/ProgramChangeSelector.hpp>

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 51 of file ProgramChangeSelector.hpp.

Inheritance diagram for ProgramChangeSelector< N >:

Collaboration diagram for ProgramChangeSelector< N >:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
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.
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.
bool	isEnabled () const
	Check if this updatable is enabled.
void	moveDown ()
	Move down this element in the list.
void	moveDown ()
	Move down this element in the list.

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class.
static void	updateAll ()
	Update all enabled instances of this class.

Public Types
using	Matcher = OneByteMIDIMatcher
using	Parent
using	MessageType

Public Member Functions
	ProgramChangeSelector (Selectable< N > &selectable, MIDIChannelCable address)
void	begin () override
	Initialize this updatable.
void	reset () override
	Reset the input element to its initial state.
void	handleUpdate (typename Matcher::Result match) override
void	update () override
	Update this updatable.
virtual void	update ()
	Update the value of the input element. Used for decaying VU meters etc.
void	set (setting_t newSetting)
	Select the given selection.
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.
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.
setting_t	get () const
	Get the current selection/setting.
bool	updateWith (MessageType midimsg) override
	Receive a new MIDI message and update the internal state.

Static Public Member Functions
static void	beginAll ()
	Begin all.
static void	updateAll ()
	Update all.
static bool	updateAllWith (MessageType midimsg)
	Update all.
static void	resetAll ()
	Reset all.

Public Attributes
EmptySelectorCallback	callback

Protected Attributes
setting_t	setting = 0
	The selection of the selector.
Updatable< NormalUpdatable > *	next
MIDIInputElement< Type > *	next
Updatable< NormalUpdatable > *	previous
MIDIInputElement< Type > *	previous
OneByteMIDIMatcher	matcher

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

Private Attributes
Selectable< N > &	selectable

Member Typedef Documentation

◆ Matcher

template<setting_t N, class Callback = EmptySelectorCallback>

using Matcher = OneByteMIDIMatcher

inherited

Definition at line 15 of file ProgramChangeSelector.hpp.

◆ Parent

template<setting_t N, class Callback = EmptySelectorCallback>

using Parent

inherited

Initial value:

MatchingMIDIInputElement<MIDIMessageType::ProgramChange, Matcher>

MatchingMIDIInputElement< MIDIMessageType::ProgramChange, OneByteMIDIMatcher >::MatchingMIDIInputElement

MatchingMIDIInputElement(const OneByteMIDIMatcher &matcher)

Definition MIDIInputElement.hpp:90

Definition at line 16 of file ProgramChangeSelector.hpp.

◆ MessageType

using MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ ProgramChangeSelector()

template<setting_t N>

ProgramChangeSelector	(	Selectable< N > &	selectable,
		MIDIChannelCable	address )

inline

Definition at line 53 of file ProgramChangeSelector.hpp.

Member Function Documentation

◆ begin()

template<setting_t N, class Callback = EmptySelectorCallback>

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 25 of file ProgramChangeSelector.hpp.

◆ reset()

template<setting_t N, class Callback = EmptySelectorCallback>

void reset ( )

inlineoverridevirtualinherited

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

Definition at line 27 of file ProgramChangeSelector.hpp.

◆ handleUpdate()

template<setting_t N, class Callback = EmptySelectorCallback>

void handleUpdate ( typename Matcher::Result match )

inlineoverridevirtualinherited

Implements MatchingMIDIInputElement< MIDIMessageType::ProgramChange, OneByteMIDIMatcher >.

Definition at line 29 of file ProgramChangeSelector.hpp.

◆ update() [1/2]

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 77 of file Selector.hpp.

◆ update() [2/2]

virtual void update ( )

inlinevirtualinherited

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

Definition at line 40 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 93 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 109 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 128 of file Selector.hpp.

◆ get()

setting_t get ( ) const

inlineinherited

Get the current selection/setting.

Definition at line 46 of file Selector.hpp.

◆ beginAll() [1/2]

template<class T = NormalUpdatable>

void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 182 of file Updatable.hpp.

◆ beginAll() [2/2]

void beginAll ( )

inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ updateAll() [1/2]

template<class T = NormalUpdatable>

void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 186 of file Updatable.hpp.

◆ updateAll() [2/2]

void updateAll ( )

inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ enable() [1/2]

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/2]

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

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/2]

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

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.

◆ isEnabled() [2/2]

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

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

◆ moveDown() [2/2]

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.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.

◆ updateAllWith()

bool updateAllWith ( MessageType midimsg )

inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ resetAll()

void resetAll ( )

inlinestaticinherited

Reset all.

Definition at line 67 of file MIDIInputElement.hpp.

Member Data Documentation

◆ selectable

Selectable<N>& selectable

privateinherited

Definition at line 141 of file Selector.hpp.

◆ callback

EmptySelectorCallback callback

inherited

Definition at line 144 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 52 of file Selector.hpp.

◆ updatables [1/2]

DoublyLinkedList<Updatable< NormalUpdatable >> updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ updatables [2/2]

DoublyLinkedList<MIDIInputElement< Type >> updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next [1/2]

Updatable< NormalUpdatable >* next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ next [2/2]

MIDIInputElement< Type >* next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous [1/2]

Updatable< NormalUpdatable >* previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ previous [2/2]

MIDIInputElement< Type >* previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ matcher

OneByteMIDIMatcher matcher

protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

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

ProgramChangeSelector.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Private Attributes

Member Typedef Documentation

◆ Matcher

◆ Parent

◆ MessageType

Constructor & Destructor Documentation

◆ ProgramChangeSelector()

Member Function Documentation

◆ begin()

◆ reset()

◆ handleUpdate()

◆ update() [1/2]

◆ update() [2/2]

◆ set()

◆ increment()

◆ decrement()

◆ get()

◆ beginAll() [1/2]

◆ beginAll() [2/2]

◆ updateAll() [1/2]

◆ updateAll() [2/2]

◆ enable() [1/2]

◆ enable() [2/2]

◆ disable() [1/2]

◆ disable() [2/2]

◆ isEnabled() [1/2]

◆ isEnabled() [2/2]

◆ moveDown() [1/2]

◆ moveDown() [2/2]

◆ updateWith()

◆ updateAllWith()

◆ resetAll()

Member Data Documentation

◆ selectable

◆ callback

◆ setting

◆ updatables [1/2]

◆ updatables [2/2]

◆ next [1/2]

◆ next [2/2]

◆ previous [1/2]

◆ previous [2/2]

◆ matcher