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 Attributes | Static Private Attributes | List of all members
GenericSelector< N, Callback > Class Template Reference

#include <Selector.hpp>

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

Public Member Functions

 GenericSelector (Selectable< N > &selectable, const Callback &callback)
 Constructor. More...
 
void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
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...
 
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...
 

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

Public Attributes

Callback callback
 

Protected Attributes

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

Private Attributes

Selectable< N > & selectable
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

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

Definition at line 57 of file Selector.hpp.

Constructor & Destructor Documentation

◆ GenericSelector()

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

Constructor.

Parameters
selectableThe selectable object to manage. When the value of the selector changes, it changes the selection of this selectable.
callbackThe callback to call when the value changes. Used for (visual) feedback from the selector (e.g. LEDs or some different kind of display).

Definition at line 70 of file Selector.hpp.

Member Function Documentation

◆ begin()

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

Initialize this updatable.

Implements Updatable<>.

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

Definition at line 73 of file Selector.hpp.

◆ update()

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

Update this updatable.

Implements Updatable<>.

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

Definition at line 78 of file Selector.hpp.

◆ reset()

template<setting_t N, class Callback = EmptySelectorCallback>
void GenericSelector< N, Callback >::reset ( )
inline

Reset the selection to the initial selection.

Definition at line 81 of file Selector.hpp.

◆ set()

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

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)
inline

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)
inline

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()

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()

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

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

Member Data Documentation

◆ selectable

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

Definition at line 137 of file Selector.hpp.

◆ callback

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

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

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

Definition at line 301 of file LinkedList.hpp.

◆ previous

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

Definition at line 302 of file LinkedList.hpp.


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