Selector that reads from a rotary encoder. More...

#include <Selectors/EncoderSelector.hpp>

Inheritance diagram for EncoderSelector< N >:

Collaboration diagram for EncoderSelector< N >:

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

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
EmptySelectorCallback	callback

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

Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Types
using	Parent = GenericSelector< N, EmptySelectorCallback >

Private Attributes
Encoder	encoder

pin_t	switchPin

int8_t	pulsesPerStep

Wrap	wrap

long	previousPosition

bool	previousSwitchState

Selectable< N > &	selectable

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

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 78 of file EncoderSelector.hpp.

Member Typedef Documentation

◆ Parent

using Parent = GenericSelector<N, EmptySelectorCallback >

privateinherited

Definition at line 17 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 80 of file EncoderSelector.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

Definition at line 27 of file EncoderSelector.hpp.

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 33 of file EncoderSelector.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

newSetting The new setting to select [0, N-1].

Definition at line 89 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 105 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 124 of file Selector.hpp.

◆ get()

setting_t get ( ) const

inlineinherited

Get the current selection/setting.

Definition at line 47 of file Selector.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 45 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( Updatable<> & element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Definition at line 90 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 55 of file Updatable.hpp.

◆ disable() [2/4]

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

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

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

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

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

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ encoder

Encoder encoder

privateinherited

Definition at line 58 of file EncoderSelector.hpp.

◆ switchPin

pin_t switchPin

privateinherited

Definition at line 59 of file EncoderSelector.hpp.

◆ pulsesPerStep

int8_t pulsesPerStep

privateinherited

Definition at line 60 of file EncoderSelector.hpp.

◆ wrap

Wrap wrap

privateinherited

Definition at line 61 of file EncoderSelector.hpp.

◆ previousPosition

long previousPosition

privateinherited

Definition at line 63 of file EncoderSelector.hpp.

◆ previousSwitchState

bool previousSwitchState

privateinherited

Definition at line 64 of file EncoderSelector.hpp.

◆ selectable

Selectable<N>& selectable

privateinherited

Definition at line 137 of file Selector.hpp.

◆ callback

EmptySelectorCallback callback

inherited

Definition at line 140 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 > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

EncoderSelector.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Types

Private Attributes

Static Private Attributes

Detailed Description

template<setting_t N> class EncoderSelector< N >

Member Typedef Documentation

◆ Parent

Constructor & Destructor Documentation

◆ EncoderSelector()

Member Function Documentation

◆ begin()

◆ update()

◆ reset()

◆ set()

◆ increment()

◆ decrement()

◆ get()

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

◆ beginAll()

◆ updateAll()

Member Data Documentation

◆ encoder

◆ switchPin

◆ pulsesPerStep

◆ wrap

◆ previousPosition

◆ previousSwitchState

◆ selectable

◆ callback

◆ setting

◆ updatables

◆ next

◆ previous

template<setting_t N>
class EncoderSelector< N >