Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
GenericMIDIRotaryEncoder< Enc, Sender > Class Template Reference

#include <MIDI_Outputs/Abstract/MIDIRotaryEncoder.hpp>

Detailed Description

template<class Enc, class Sender>
class GenericMIDIRotaryEncoder< Enc, Sender >

An abstract class for rotary encoders that send MIDI events.

Examples
MCP23017-RotaryEncoder-Interrupts.ino, and MCP23017-RotaryEncoder-No-Interrupts.ino.

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

+ Inheritance diagram for GenericMIDIRotaryEncoder< Enc, Sender >:
+ Collaboration diagram for GenericMIDIRotaryEncoder< Enc, Sender >:

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

 GenericMIDIRotaryEncoder (Enc &&encoder, MIDIAddress address, int16_t speedMultiply, uint8_t pulsesPerStep, const Sender &sender)
 Construct a new MIDIRotaryEncoder. More...
 
void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
void setSpeedMultiply (int16_t speedMultiply)
 
int16_t getSpeedMultiply () const
 

Public Attributes

Sender sender
 

Protected Attributes

Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

Enc encoder
 
MIDIAddress address
 
EncoderState< decltype(encoder.read())> encstate
 

Constructor & Destructor Documentation

◆ GenericMIDIRotaryEncoder()

GenericMIDIRotaryEncoder ( Enc &&  encoder,
MIDIAddress  address,
int16_t  speedMultiply,
uint8_t  pulsesPerStep,
const Sender &  sender 
)
inline

Construct a new MIDIRotaryEncoder.

Examples
MCP23017-RotaryEncoder-Interrupts.ino, and MCP23017-RotaryEncoder-No-Interrupts.ino.

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

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 36 of file Abstract/MIDIRotaryEncoder.hpp.

◆ update()

void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 38 of file Abstract/MIDIRotaryEncoder.hpp.

◆ setSpeedMultiply()

void setSpeedMultiply ( int16_t  speedMultiply)
inline

Definition at line 45 of file Abstract/MIDIRotaryEncoder.hpp.

◆ getSpeedMultiply()

int16_t getSpeedMultiply ( ) const
inline

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

Enc encoder
private

Definition at line 51 of file Abstract/MIDIRotaryEncoder.hpp.

◆ address

MIDIAddress address
private

Definition at line 52 of file Abstract/MIDIRotaryEncoder.hpp.

◆ encstate

EncoderState<decltype(encoder.read())> encstate
private

Definition at line 53 of file Abstract/MIDIRotaryEncoder.hpp.

◆ sender

Sender sender

Definition at line 56 of file Abstract/MIDIRotaryEncoder.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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