#include <Selectors/EncoderSelector.hpp>

Detailed Description

template<setting_t N>
class EncoderSelector< N >

Selector that reads from a rotary encoder.

Template Parameters

N	The number of settings.

Examples: Encoder-Selector-Bank.ino.

Definition at line 81 of file EncoderSelector.hpp.

Inheritance diagram for EncoderSelector< N >:

Collaboration diagram for EncoderSelector< N >:

Enabling and disabling updatables
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 () const
	Check if this updatable is enabled. 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...

Public Member Functions
	EncoderSelector (Selectable< N > &selectable, const EncoderSwitchPinList &pins, int8_t pulsesPerStep=4, Wrap wrap=Wrap::Wrap)

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

Public Attributes
EmptySelectorCallback	callback

Protected Attributes
setting_t	setting = 0
	The selection of the selector. More...

Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

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

Private Types
using	Parent = GenericSelector< N, Callback >

Private Attributes
AHEncoder	encoder

pin_t	switchPin

int8_t	pulsesPerStep

Wrap	wrap

long	previousPosition = 0

bool	previousSwitchState = HIGH

Selectable< N > &	selectable

Member Typedef Documentation

◆ Parent

using Parent = GenericSelector<N, Callback>

privateinherited

Definition at line 18 of file EncoderSelector.hpp.

Constructor & Destructor Documentation

◆ EncoderSelector()

EncoderSelector	(	Selectable< N > &	selectable,
		const EncoderSwitchPinList &	pins,
		int8_t	pulsesPerStep = `4`,
		Wrap	wrap = `Wrap::Wrap`
	)

inline

Definition at line 83 of file EncoderSelector.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 28 of file EncoderSelector.hpp.

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 35 of file EncoderSelector.hpp.

◆ reset()

void reset ( )

inlineinherited

Reset the selection to the initial selection.

Definition at line 80 of file Selector.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()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 190 of file Updatable.hpp.

◆ enable() [1/4]

void enable ( )

inlineinherited

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

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/4]

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

inlinestaticinherited

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

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

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

inlinestaticinherited

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

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

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

◆ disable() [1/4]

void disable ( )

inlineinherited

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

Definition at line 110 of file Updatable.hpp.

◆ disable() [2/4]

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

inlinestaticinherited

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

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

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

inlinestaticinherited

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

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

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

◆ isEnabled()

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

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

Member Data Documentation

◆ encoder

AHEncoder encoder

privateinherited

Definition at line 61 of file EncoderSelector.hpp.

◆ switchPin

pin_t switchPin

privateinherited

Definition at line 62 of file EncoderSelector.hpp.

◆ pulsesPerStep

int8_t pulsesPerStep

privateinherited

Definition at line 63 of file EncoderSelector.hpp.

◆ wrap

Wrap wrap

privateinherited

Definition at line 64 of file EncoderSelector.hpp.

◆ previousPosition

long previousPosition = 0

privateinherited

Definition at line 66 of file EncoderSelector.hpp.

◆ previousSwitchState

bool previousSwitchState = HIGH

privateinherited

Definition at line 67 of file EncoderSelector.hpp.

◆ 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

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 325 of file LinkedList.hpp.

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

EncoderSelector.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Private Types

Private Attributes

Member Typedef Documentation

◆ Parent

Constructor & Destructor Documentation

◆ EncoderSelector()

Member Function Documentation

◆ begin()

◆ update()

◆ reset()

◆ set()

◆ increment()

◆ decrement()

◆ get()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ encoder

◆ switchPin

◆ pulsesPerStep

◆ wrap

◆ previousPosition

◆ previousSwitchState

◆ selectable

◆ callback

◆ setting

◆ updatables

◆ next

◆ previous