Control Surface  master
MIDI Control Surface library for Arduino
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Types | Private Attributes | List of all members
IncrementSelector< N > Class Template Reference

Selector with one button that increments the selection. More...

#include <Selectors/IncrementSelector.hpp>

+ Inheritance diagram for IncrementSelector< N >:
+ Collaboration diagram for IncrementSelector< N >:

Public Types

using Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type
 
using LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type
 

Public Member Functions

 IncrementSelector (Selectable< N > &selectable, const AH::IncrementButton &button)
 
 IncrementSelector (Selectable< N > &selectable, const AH::Button &button)
 
void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
AH::IncrementButton::State getButtonState () const
 
void invert ()
 
void reset ()
 Reset the selection to the initial selection. 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...
 

Static Public Member Functions

static MutexgetMutex ()
 

Public Attributes

EmptySelectorCallback callback
 

Protected Attributes

setting_t setting = 0
 The selection of the selector. More...
 
Updatable< NormalUpdatable, false > * next
 
Updatable< NormalUpdatable, false > * previous
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable, false > > updatables
 
static Mutex mutex
 

Private Types

using Parent = GenericSelector< N, EmptySelectorCallback >
 

Private Attributes

AH::IncrementButton button
 
Selectable< N > & selectable
 

Main initialization and updating methods

static void applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)
 
static void applyToAll (void(Derived::*method)(Args &&...), Args &&... args)
 

Enabling and disabling updatables

void enable (const LockGuard &lock)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
void enable ()
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
void disable (const LockGuard &lock)
 Disable this updatable: remove it from the linked list of instances, so it no longer 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 (const LockGuard &) const
 Check if this updatable is enabled. More...
 
bool isEnabled ()
 Check if this updatable is enabled. More...
 
void moveDown (const LockGuard &)
 Move down this element in the list. More...
 
void moveDown ()
 Move down this element in the list. More...
 
static void enable (UpdatableCRTP *element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
static void enable (UpdatableCRTP &element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
static void enable (U(&array)[N])
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...
 
static void disable (UpdatableCRTP *element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 
static void disable (UpdatableCRTP &element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 
static void disable (U(&array)[N])
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...
 

Main initialization and updating methods

static void beginAll ()
 Begin all enabled instances of this class. More...
 
static void updateAll ()
 Update all enabled instances of this class. More...
 

Detailed Description

template<setting_t N>
class IncrementSelector< N >

Selector with one button that increments the selection.

Template Parameters
NThe number of settings.
Examples
Custom-MIDI-Output-Element-Bankable.ino, MCU-OLED-SSD1306-x2.ino, and Transpose-Octave-NC-Button.ino.

Definition at line 64 of file IncrementSelector.hpp.

Member Typedef Documentation

◆ Parent

using Parent = GenericSelector<N, EmptySelectorCallback >
privateinherited

Definition at line 10 of file IncrementSelector.hpp.

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type
inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type
inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ IncrementSelector() [1/2]

IncrementSelector ( Selectable< N > &  selectable,
const AH::IncrementButton button 
)
inline

Definition at line 66 of file IncrementSelector.hpp.

◆ IncrementSelector() [2/2]

IncrementSelector ( Selectable< N > &  selectable,
const AH::Button button 
)
inline

Definition at line 70 of file IncrementSelector.hpp.

Member Function Documentation

◆ begin()

void begin
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

Definition at line 18 of file IncrementSelector.hpp.

◆ update()

void update
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 23 of file IncrementSelector.hpp.

◆ getButtonState()

AH::IncrementButton::State getButtonState
inlineinherited

Definition at line 37 of file IncrementSelector.hpp.

◆ invert()

void invert
inlineinherited

Definition at line 42 of file IncrementSelector.hpp.

◆ reset()

void reset ( )
inlineinherited

Reset the selection to the initial selection.

Definition at line 81 of file Selector.hpp.

◆ set()

void set ( setting_t  newSetting)
inlineinherited

Select the given selection.

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

Definition at line 94 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
wrapWrap or clamp if the new setting would be out of range.

Definition at line 110 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
wrapWrap or clamp if the new setting would be out of range.

Definition at line 129 of file Selector.hpp.

◆ get()

setting_t get ( ) const
inlineinherited

Get the current selection/setting.

Definition at line 47 of file Selector.hpp.

◆ beginAll()

static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )
inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll ( const LockGuard ,
void(Derived::*)(Args &&...)  method,
Args &&...  args 
)
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll ( void(Derived::*)(Args &&...)  method,
Args &&...  args 
)
inlinestaticinherited

Definition at line 93 of file Updatable.hpp.

◆ enable() [1/5]

void enable ( const LockGuard lock)
inlineinherited

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

Definition at line 106 of file Updatable.hpp.

◆ enable() [2/5]

void enable ( )
inlineinherited

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

Definition at line 115 of file Updatable.hpp.

◆ enable() [3/5]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable, false >, false > *  element)
inlinestaticinherited

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

Definition at line 144 of file Updatable.hpp.

◆ enable() [4/5]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable, false >, false > &  element)
inlinestaticinherited

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

Definition at line 146 of file Updatable.hpp.

◆ enable() [5/5]

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

◆ disable() [1/5]

void disable ( const LockGuard lock)
inlineinherited

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

Definition at line 119 of file Updatable.hpp.

◆ disable() [2/5]

void disable ( )
inlineinherited

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

Definition at line 128 of file Updatable.hpp.

◆ disable() [3/5]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable, false >, false > *  element)
inlinestaticinherited

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

Definition at line 155 of file Updatable.hpp.

◆ disable() [4/5]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable, false >, false > &  element)
inlinestaticinherited

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

Definition at line 157 of file Updatable.hpp.

◆ disable() [5/5]

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

◆ isEnabled() [1/2]

bool isEnabled ( const LockGuard ) 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 136 of file Updatable.hpp.

◆ isEnabled() [2/2]

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

◆ moveDown() [1/2]

void moveDown ( const LockGuard )
inlineinherited

Move down this element in the list.

Definition at line 166 of file Updatable.hpp.

◆ moveDown() [2/2]

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 168 of file Updatable.hpp.

Member Data Documentation

◆ button

AH::IncrementButton button
privateinherited

Definition at line 46 of file IncrementSelector.hpp.

◆ selectable

Selectable<N>& selectable
privateinherited

Definition at line 142 of file Selector.hpp.

◆ callback

EmptySelectorCallback callback
inherited

Definition at line 145 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, false > > updatables
staticprotectedinherited

Definition at line 173 of file Updatable.hpp.

◆ mutex

UpdatableCRTP< Updatable< NormalUpdatable, false > , ThreadSafe >::Mutex mutex
staticprotectedinherited

Definition at line 174 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable, false > * next
protectedinherited

Definition at line 323 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable, false > * previous
protectedinherited

Definition at line 324 of file LinkedList.hpp.


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