An abstract class for rotary encoders that send MIDI events and that can be added to a Bank. More...

#include <MIDI_Outputs/Bankable/Abstract/MIDIRotaryEncoder.hpp>

Inheritance diagram for MIDIRotaryEncoder< BankAddress, Sender >:

Collaboration diagram for MIDIRotaryEncoder< BankAddress, Sender >:

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
void	begin () final override
	Initialize this updatable. More...

void	update () final override
	Update this updatable. More...

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
Sender	sender

Protected Member Functions
	MIDIRotaryEncoder (BankAddress bankAddress, const EncoderPinList &pins, uint8_t speedMultiply, uint8_t pulsesPerStep, const Sender &sender)
	Construct a new MIDIRotaryEncoder. More...

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

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

static Mutex	mutex

Private Attributes
BankAddress	address

Encoder	encoder

const uint8_t	speedMultiply

const uint8_t	pulsesPerStep

long	previousPosition = 0

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<class BankAddress, class Sender>
class Bankable::MIDIRotaryEncoder< BankAddress, Sender >

An abstract class for rotary encoders that send MIDI events and that can be added to a Bank.

Definition at line 23 of file Bankable/Abstract/MIDIRotaryEncoder.hpp.

Member Typedef Documentation

◆ 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

◆ MIDIRotaryEncoder()

MIDIRotaryEncoder	(	BankAddress	bankAddress,
		const EncoderPinList &	pins,
		uint8_t	speedMultiply,
		uint8_t	pulsesPerStep,
		const Sender &	sender
	)

inlineprotected

Construct a new MIDIRotaryEncoder.

Todo:: Documentation

Definition at line 30 of file Bankable/Abstract/MIDIRotaryEncoder.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

Definition at line 49 of file Bankable/Abstract/MIDIRotaryEncoder.hpp.

◆ update()

void update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

Definition at line 50 of file Bankable/Abstract/MIDIRotaryEncoder.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.