Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Protected Attributes | Static Protected Attributes | List of all members
Updatable< T > Class Template Referenceabstract

#include <AH/Containers/Updatable.hpp>

Detailed Description

template<class T = NormalUpdatable>
class AH::Updatable< T >

A super class for object that have to be updated regularly.

All instances of this class are kept in a linked list, so it's easy to iterate over all of them to update them.

Examples
Custom-MIDI-Output-Element-Bankable.ino, and Custom-MIDI-Output-Element.ino.

Definition at line 169 of file Updatable.hpp.

+ Inheritance diagram for Updatable< T >:
+ Collaboration diagram for Updatable< T >:

Main initialization and updating methods

virtual void begin ()=0
 Initialize this updatable.
 
virtual void update ()=0
 Update this updatable.
 
static void beginAll ()
 Begin all enabled instances of this class.
 
static void updateAll ()
 Update all enabled instances of this class.
 

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.
 
template<class U , size_t N>
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.
 
template<class U , size_t N>
static void disable (U(&array)[N])
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 

Protected Attributes

Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Member Function Documentation

◆ begin()

template<class T = NormalUpdatable>
virtual void begin ( )
pure virtual

Initialize this updatable.

Implemented in MIDIButtonLatched< Sender >, MIDIButtonLatched< DigitalCCSender >, MIDIButtonLatched< DigitalNoteSender >, MIDIButtonMatrix< Sender, NumRows, NumCols >, MIDIButtonMatrix< DigitalCCSender, NumRows, NumCols >, MIDIButtonMatrix< DigitalNoteSender, NumRows, NumCols >, MIDIButtons< Sender, NumButtons >, MIDIButtons< DigitalCCSender, NumButtons >, MIDIButtons< DigitalNoteSender, NumButtons >, MIDIChordButton< Sender >, MIDIFilteredAnalog< Sender >, MIDIFilteredAnalog< ContinuousCCSender >, MIDIFilteredAnalog< PitchBendSender< 10 > >, MIDIButtons< BankAddress, Sender, NumButtons >, MIDIButtons< SingleAddress, DigitalCCSender, NumButtons >, MIDIButtons< SingleAddress, DigitalNoteSender, NumButtons >, MIDIFilteredAnalog< BankAddress, Sender >, MIDIFilteredAnalog< ManyAddresses< NumBanks >, ContinuousCCSender >, MIDIFilteredAnalog< ManyAddresses< NumBanks >, PitchBendSender< 10 > >, MIDIFilteredAnalog< SingleAddress, ContinuousCCSender >, MIDIFilteredAnalog< SingleAddress, PitchBendSender< 10 > >, AudioVULEDs< N >, VolumeControl< N >, SerialDebugMIDI_Interface< T >, SerialDebugMIDI_Interface< decltype(Serial)>, SerialDebugMIDI_Interface< HardwareSerial >, SerialDebugMIDI_Interface< SoftwareSerial >, GenericBLEMIDI_Interface< Backend >, GenericBLEMIDI_Interface< BLEMIDIBackend >, MIDI_Interface, SerialMIDI_Interface< S >, SerialMIDI_Interface< decltype(Serial)>, SerialMIDI_Interface< HardwareSerial >, SerialMIDI_Interface< SoftwareSerial >, GenericUSBMIDI_Interface< Backend >, GenericUSBMIDI_Interface< USBDeviceMIDIBackend >, GenericUSBMIDI_Interface< USBHostMIDIBackend< 512 > >, GenericUSBMIDI_Interface< USBHostMIDIBackend< 64 > >, FortySevenEffectsMIDI_Interface< MidiInterface >, GenericMIDIAbsoluteEncoder< Enc, Sender >, MIDIButton< Sender >, MIDIButton< DigitalCCSender >, MIDIButton< DigitalNoteSender >, MIDIButton< ProgramChangeSender >, MIDIButtonLatching< Sender >, MIDIButtonLatching< DigitalCCSender >, MIDIButtonLatching< DigitalNoteSender >, MIDIIncrementDecrementButtons< RelativeSender, ResetSender >, MIDIIncrementDecrementButtons< RelativeCCSender, DigitalNoteSender >, GenericMIDIRotaryEncoder< Enc, Sender >, GenericMIDIAbsoluteEncoder< Enc, NumBanks, BankAddress, Sender >, MIDIButton< BankAddress, Sender >, MIDIButton< ManyAddresses< NumBanks >, DigitalCCSender >, MIDIButton< ManyAddresses< NumBanks >, DigitalNoteSender >, MIDIButton< ManyAddresses< NumBanks >, ProgramChangeSender >, MIDIButton< SingleAddress, DigitalCCSender >, MIDIButton< SingleAddress, DigitalNoteSender >, MIDIButton< SingleAddress, ProgramChangeSender >, MIDIButtonLatched< NumBanks, BankAddress, Sender >, MIDIButtonLatched< NumBanks, SingleAddress, DigitalCCSender >, MIDIButtonLatched< NumBanks, SingleAddress, DigitalNoteSender >, MIDIButtonLatching< BankAddress, Sender >, MIDIButtonLatching< SingleAddress, DigitalCCSender >, MIDIButtonLatching< SingleAddress, DigitalNoteSender >, MIDIButtonMatrix< BankAddress, Sender, NumRows, NumCols >, MIDIButtonMatrix< ManyMatrixAddresses< NumBanks, NumRows, NumCols >, DigitalCCSender, NumRows, NumCols >, MIDIButtonMatrix< ManyMatrixAddresses< NumBanks, NumRows, NumCols >, DigitalNoteSender, NumRows, NumCols >, MIDIButtonMatrix< MatrixAddress< NumRows, NumCols >, DigitalCCSender, NumRows, NumCols >, MIDIButtonMatrix< MatrixAddress< NumRows, NumCols >, DigitalNoteSender, NumRows, NumCols >, MIDIChordButton< Sender >, MIDIChordButton< DigitalNoteSender >, MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >, MIDIIncrementDecrementButtons< DualAddresses, RelativeCCSender, DigitalNoteSender >, MIDIIncrementDecrementButtons< DualManyAddresses< NumBanks >, RelativeCCSender, DigitalNoteSender >, GenericMIDIRotaryEncoder< Enc, BankAddress, Sender >, SmartMIDIFilteredAnalog< NumBanks, BankAddress, Sender >, SmartMIDIFilteredAnalog< NumBanks, SingleAddress, ContinuousCCSender >, SmartMIDIFilteredAnalog< NumBanks, SingleAddress, PitchBendSender< 10 > >, GenericEncoderSelector< N, Callback >, GenericEncoderSelector< N, SelectorLEDsCallback< N > >, GenericIncrementDecrementSelector< N, Callback >, GenericIncrementDecrementSelector< N, SelectorLEDsCallback< N > >, GenericIncrementSelector< N, Callback >, GenericIncrementSelector< N, SelectorLEDsCallback< N > >, GenericManyButtonsSelector< N, Callback >, GenericManyButtonsSelector< N, SelectorLEDsCallback< N > >, GenericProgramChangeSelector< N, Callback >, GenericProgramChangeSelector< N, SelectorLEDsCallback< N > >, GenericSelector< N, Callback >, GenericSelector< 2, EmptySelectorCallback >, GenericSelector< 2, SelectorSingleLEDCallback >, GenericSelector< N, EmptySelectorCallback >, GenericSelector< N, SelectorLEDsCallback< N > >, GenericSwitchSelector< Callback >, and GenericSwitchSelector< SelectorSingleLEDCallback >.

Examples
Custom-MIDI-Output-Element-Bankable.ino, and Custom-MIDI-Output-Element.ino.

◆ update()

template<class T = NormalUpdatable>
virtual void update ( )
pure virtual

Update this updatable.

Implemented in MIDIButtonLatched< Sender >, MIDIButtonLatched< DigitalCCSender >, MIDIButtonLatched< DigitalNoteSender >, MIDIButtonMatrix< Sender, NumRows, NumCols >, MIDIButtonMatrix< DigitalCCSender, NumRows, NumCols >, MIDIButtonMatrix< DigitalNoteSender, NumRows, NumCols >, MIDIButtons< Sender, NumButtons >, MIDIButtons< DigitalCCSender, NumButtons >, MIDIButtons< DigitalNoteSender, NumButtons >, MIDIChordButton< Sender >, MIDIFilteredAnalog< Sender >, MIDIFilteredAnalog< ContinuousCCSender >, MIDIFilteredAnalog< PitchBendSender< 10 > >, MIDIButtons< BankAddress, Sender, NumButtons >, MIDIButtons< SingleAddress, DigitalCCSender, NumButtons >, MIDIButtons< SingleAddress, DigitalNoteSender, NumButtons >, MIDIFilteredAnalog< BankAddress, Sender >, MIDIFilteredAnalog< ManyAddresses< NumBanks >, ContinuousCCSender >, MIDIFilteredAnalog< ManyAddresses< NumBanks >, PitchBendSender< 10 > >, MIDIFilteredAnalog< SingleAddress, ContinuousCCSender >, MIDIFilteredAnalog< SingleAddress, PitchBendSender< 10 > >, AudioVULEDs< N >, VolumeControl< N >, StreamDebugMIDI_Interface, GenericBLEMIDI_Interface< Backend >, GenericBLEMIDI_Interface< BLEMIDIBackend >, StreamMIDI_Interface, GenericUSBMIDI_Interface< Backend >, GenericUSBMIDI_Interface< USBDeviceMIDIBackend >, GenericUSBMIDI_Interface< USBHostMIDIBackend< 512 > >, GenericUSBMIDI_Interface< USBHostMIDIBackend< 64 > >, FortySevenEffectsMIDI_Interface< MidiInterface >, GenericMIDIAbsoluteEncoder< Enc, Sender >, MIDIButton< Sender >, MIDIButton< DigitalCCSender >, MIDIButton< DigitalNoteSender >, MIDIButton< ProgramChangeSender >, MIDIButtonLatching< Sender >, MIDIButtonLatching< DigitalCCSender >, MIDIButtonLatching< DigitalNoteSender >, MIDIIncrementDecrementButtons< RelativeSender, ResetSender >, MIDIIncrementDecrementButtons< RelativeCCSender, DigitalNoteSender >, GenericMIDIRotaryEncoder< Enc, Sender >, GenericMIDIAbsoluteEncoder< Enc, NumBanks, BankAddress, Sender >, MIDIButton< BankAddress, Sender >, MIDIButton< ManyAddresses< NumBanks >, DigitalCCSender >, MIDIButton< ManyAddresses< NumBanks >, DigitalNoteSender >, MIDIButton< ManyAddresses< NumBanks >, ProgramChangeSender >, MIDIButton< SingleAddress, DigitalCCSender >, MIDIButton< SingleAddress, DigitalNoteSender >, MIDIButton< SingleAddress, ProgramChangeSender >, MIDIButtonLatched< NumBanks, BankAddress, Sender >, MIDIButtonLatched< NumBanks, SingleAddress, DigitalCCSender >, MIDIButtonLatched< NumBanks, SingleAddress, DigitalNoteSender >, MIDIButtonLatching< BankAddress, Sender >, MIDIButtonLatching< SingleAddress, DigitalCCSender >, MIDIButtonLatching< SingleAddress, DigitalNoteSender >, MIDIButtonMatrix< BankAddress, Sender, NumRows, NumCols >, MIDIButtonMatrix< ManyMatrixAddresses< NumBanks, NumRows, NumCols >, DigitalCCSender, NumRows, NumCols >, MIDIButtonMatrix< ManyMatrixAddresses< NumBanks, NumRows, NumCols >, DigitalNoteSender, NumRows, NumCols >, MIDIButtonMatrix< MatrixAddress< NumRows, NumCols >, DigitalCCSender, NumRows, NumCols >, MIDIButtonMatrix< MatrixAddress< NumRows, NumCols >, DigitalNoteSender, NumRows, NumCols >, MIDIChordButton< Sender >, MIDIChordButton< DigitalNoteSender >, MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >, MIDIIncrementDecrementButtons< DualAddresses, RelativeCCSender, DigitalNoteSender >, MIDIIncrementDecrementButtons< DualManyAddresses< NumBanks >, RelativeCCSender, DigitalNoteSender >, GenericMIDIRotaryEncoder< Enc, BankAddress, Sender >, SmartMIDIFilteredAnalog< NumBanks, BankAddress, Sender >, SmartMIDIFilteredAnalog< NumBanks, SingleAddress, ContinuousCCSender >, SmartMIDIFilteredAnalog< NumBanks, SingleAddress, PitchBendSender< 10 > >, GenericEncoderSelector< N, Callback >, GenericEncoderSelector< N, SelectorLEDsCallback< N > >, GenericIncrementDecrementSelector< N, Callback >, GenericIncrementDecrementSelector< N, SelectorLEDsCallback< N > >, GenericIncrementSelector< N, Callback >, GenericIncrementSelector< N, SelectorLEDsCallback< N > >, GenericManyButtonsSelector< N, Callback >, GenericManyButtonsSelector< N, SelectorLEDsCallback< N > >, GenericSelector< N, Callback >, GenericSelector< 2, EmptySelectorCallback >, GenericSelector< 2, SelectorSingleLEDCallback >, GenericSelector< N, EmptySelectorCallback >, GenericSelector< N, SelectorLEDsCallback< N > >, GenericSwitchSelector< Callback >, GenericSwitchSelector< SelectorSingleLEDCallback >, and MIDI_Interface.

Examples
Custom-MIDI-Output-Element-Bankable.ino, and Custom-MIDI-Output-Element.ino.

◆ beginAll()

template<class T = NormalUpdatable>
static void beginAll ( )
inlinestatic

Begin all enabled instances of this class.

See also
begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>
static void updateAll ( )
inlinestatic

Update all enabled instances of this class.

See also
update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >
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]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > * 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]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > & 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]

template<class Derived >
template<class U , size_t N>
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]

template<class Derived >
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]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > * 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]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > & 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]

template<class Derived >
template<class U , size_t N>
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()

template<class Derived >
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()

template<class Derived >
void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ updatables

template<class Derived >
DoublyLinkedList< Derived > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.10.0