This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
GenericProgramChangeSelector< N, Callback > Class Template Reference

#include <ProgramChangeSelector.hpp>

Inheritance diagram for GenericProgramChangeSelector< N, Callback >:
Collaboration diagram for GenericProgramChangeSelector< N, Callback >:

Public Member Functions

 GenericProgramChangeSelector (Selectable< N > &selectable, const Callback &callback, 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...
 
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...
 
virtual void update ()
 Update the value of the input element. Used for decaying VU meters etc. 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 updateAll ()
 Update all enabled instances of this class. More...
 
static void beginAll ()
 
static void resetAll ()
 Reset all MIDIInputElementPC elements to their initial state. More...
 
static void updateAll ()
 Update all MIDIInputElementPC elements. More...
 
static void updateAllWith (const ChannelMessageMatcher &midimsg)
 Update all MIDIInputElementPC elements with a new MIDI message. More...
 

Public Attributes

Callback callback
 

Protected Attributes

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

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< MIDIInputElementPCelements
 

Detailed Description

template<setting_t N, class Callback = EmptySelectorCallback>
class GenericProgramChangeSelector< N, Callback >

Definition at line 9 of file ProgramChangeSelector.hpp.

Constructor & Destructor Documentation

◆ GenericProgramChangeSelector()

template<setting_t N, class Callback = EmptySelectorCallback>
GenericProgramChangeSelector< N, Callback >::GenericProgramChangeSelector ( Selectable< N > &  selectable,
const Callback &  callback,
const MIDICNChannel address 
)
inline

Definition at line 12 of file ProgramChangeSelector.hpp.

Member Function Documentation

◆ begin()

template<setting_t N, class Callback = EmptySelectorCallback>
void GenericProgramChangeSelector< N, Callback >::begin ( )
inlineoverridevirtual

Initialize the input element.

Reimplemented from MIDIInputElement.

Definition at line 18 of file ProgramChangeSelector.hpp.

◆ reset()

template<setting_t N, class Callback = EmptySelectorCallback>
void GenericProgramChangeSelector< N, Callback >::reset ( )
inlineoverridevirtual

Reset the input element to its initial state.

Reimplemented from MIDIInputElement.

Definition at line 23 of file ProgramChangeSelector.hpp.

◆ updateImpl()

template<setting_t N, class Callback = EmptySelectorCallback>
bool GenericProgramChangeSelector< N, Callback >::updateImpl ( const ChannelMessageMatcher midimsg,
const MIDICNChannelAddress target 
)
inlineoverridevirtual

Update the internal state with the new MIDI message.

Implements MIDIInputElement.

Definition at line 25 of file ProgramChangeSelector.hpp.

◆ update() [1/2]

template<setting_t N, class Callback = EmptySelectorCallback>
void GenericSelector< N, Callback >::update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Reimplemented in GenericSwitchSelector< SelectorSingleLEDCallback >, and GenericSwitchSelector<>.

Definition at line 78 of file Selector.hpp.

◆ set()

template<setting_t N, class Callback = EmptySelectorCallback>
void GenericSelector< N, Callback >::set ( setting_t  newSetting)
inlineinherited

Select the given selection.

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

Definition at line 89 of file Selector.hpp.

◆ increment()

template<setting_t N, class Callback = EmptySelectorCallback>
void GenericSelector< N, Callback >::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
wrapWrap or clamp if the new setting would be out of range.

Definition at line 105 of file Selector.hpp.

◆ decrement()

template<setting_t N, class Callback = EmptySelectorCallback>
void GenericSelector< N, Callback >::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
wrapWrap or clamp if the new setting would be out of range.

Definition at line 124 of file Selector.hpp.

◆ get()

setting_t SelectorBase::get ( ) const
inlineinherited

Get the current selection/setting.

Definition at line 47 of file Selector.hpp.

◆ enable() [1/4]

void Updatable< NormalUpdatable >::enable ( )
inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 40 of file Updatable.hpp.

◆ enable() [2/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> &  element)
inlinestaticinherited

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

static void Updatable< NormalUpdatable >::enable ( U(&)  array[N])
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< NormalUpdatable >::disable ( )
inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 50 of file Updatable.hpp.

◆ disable() [2/4]

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

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

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

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

static void Updatable< NormalUpdatable >::disable ( U(&)  array[N])
inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< NormalUpdatable >::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 64 of file Updatable.hpp.

◆ beginAll() [1/2]

static void Updatable< NormalUpdatable >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll() [1/2]

static void Updatable< NormalUpdatable >::updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

◆ beginAll() [2/2]

static void MIDIInputElementPC::beginAll ( )
inlinestaticinherited

Definition at line 37 of file MIDIInputElementPC.hpp.

◆ resetAll()

static void MIDIInputElementPC::resetAll ( )
inlinestaticinherited

Reset all MIDIInputElementPC elements to their initial state.

See also
MIDIInputElementPC::reset

Definition at line 49 of file MIDIInputElementPC.hpp.

◆ updateAll() [2/2]

static void MIDIInputElementPC::updateAll ( )
inlinestaticinherited

Update all MIDIInputElementPC elements.

Definition at line 58 of file MIDIInputElementPC.hpp.

◆ updateAllWith()

static void MIDIInputElementPC::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 MIDIInputElementPC::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 MIDIInputElementPC::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.

◆ update() [2/2]

virtual void MIDIInputElement::update ( )
inlinevirtualinherited

◆ updateWith()

bool MIDIInputElement::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 MIDIInputElement::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 MCU::Bankable::GenericVU< NumBanks, Callback >, MCU::Bankable::GenericVU< NumBanks >, MCU::Bankable::GenericVU< NumBanks, VULEDsCallback< NumLEDs > >, MCU::Bankable::GenericVPotRing< NumBanks, Callback >, MCU::Bankable::GenericVPotRing< NumBanks >, MCU::Bankable::GenericVPotRing< NumBanks, VPotRingLEDsCallback >, Bankable::GenericNoteCCRange< MIDIInputElementNote, 1, BankSize, NoteCCFastLED< ColorMapper > >, Bankable::GenericNoteCCRange< MIDIInputElementCC, 1, NumBanks >, Bankable::GenericNoteCCRange< MIDIInputElementNote, RangeLen, BankSize, NoteCCFastLED< ColorMapper > >, Bankable::GenericNoteCCRange< MIDIInputElementCC, RangeLen, BankSize, NoteCCFastLED< ColorMapper > >, Bankable::GenericNoteCCRange< MIDIInputElementCC, 1, BankSize, NoteCCLED< 1 > >, Bankable::GenericNoteCCRange< MIDIInputElementNote, RangeLen, BankSize, NoteCCLED< RangeLen > >, Bankable::GenericNoteCCRange< MIDIInputElementNote, RangeLen, NumBanks >, Bankable::GenericNoteCCRange< MIDIInputElementNote, 1, NumBanks >, Bankable::GenericNoteCCRange< MIDIInputElementNote, 1, BankSize, NoteCCLEDBarCallback< NumLEDs > >, Bankable::GenericNoteCCRange< MIDIInputElementNote, 1, BankSize, NoteCCLED< 1 > >, Bankable::GenericNoteCCRange< MIDIInputElementCC, 1, BankSize, NoteCCFastLED< ColorMapper > >, Bankable::GenericNoteCCRange< MIDIInputElementCC, 1, BankSize, NoteCCLEDBarCallback< NumLEDs > >, Bankable::GenericNoteCCRange< MIDIInputElementCC, RangeLen, BankSize, NoteCCLED< RangeLen > >, Bankable::GenericNoteCCRange< MIDIInputElementCC, RangeLen, NumBanks >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, NoteCCFastLED< ColorMapper > >, GenericNoteCCRange< MIDIInputElementCC, 1, NoteCCLED< 1 > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen >, GenericNoteCCRange< MIDIInputElementNote, 1, NoteCCLED< 1 > >, GenericNoteCCRange< MIDIInputElementNote, 1, NoteCCFastLED< ColorMapper > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, NoteCCLED< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, RangeLen, NoteCCFastLED< ColorMapper > >, GenericNoteCCRange< MIDIInputElementCC, 1 >, GenericNoteCCRange< MIDIInputElementCC, 1, NoteCCLEDBarCallback< NumLEDs > >, GenericNoteCCRange< MIDIInputElementCC, RangeLen, NoteCCLED< RangeLen > >, GenericNoteCCRange< MIDIInputElementNote, 1, NoteCCLEDBarCallback< NumLEDs > >, GenericNoteCCRange< MIDIInputElementNote, 1 >, GenericNoteCCRange< MIDIInputElementCC, RangeLen >, GenericNoteCCRange< MIDIInputElementCC, 1, NoteCCFastLED< ColorMapper > >, MCU::SevenSegmentDisplay< LENGTH >, MCU::SevenSegmentDisplay< AssignmentDisplayLength >, and MCU::SevenSegmentDisplay< TimeDisplayLength >.

Definition at line 75 of file MIDIInputElement.hpp.

Member Data Documentation

◆ selectable

template<setting_t N, class Callback = EmptySelectorCallback>
Selectable<N>& GenericSelector< N, Callback >::selectable
privateinherited

Definition at line 137 of file Selector.hpp.

◆ callback

template<setting_t N, class Callback = EmptySelectorCallback>
Callback GenericSelector< N, Callback >::callback
inherited

Definition at line 140 of file Selector.hpp.

◆ setting

setting_t SelectorBase::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 > > Updatable< NormalUpdatable >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next [1/2]

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous [1/2]

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.

◆ elements

DoublyLinkedList< MIDIInputElementPC > MIDIInputElementPC::elements
staticprivateinherited

Definition at line 100 of file MIDIInputElementPC.hpp.

◆ address

const MIDICNChannelAddress MIDIInputElement::address
protectedinherited

Definition at line 80 of file MIDIInputElement.hpp.

◆ next [2/2]

MIDIInputElementPC * DoublyLinkable< MIDIInputElementPC >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous [2/2]

MIDIInputElementPC * DoublyLinkable< MIDIInputElementPC >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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