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 Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
MIDIRotaryEncoder< Sender > Class Template Reference

An abstract class for rotary encoders that send MIDI events. More...

#include <MIDIRotaryEncoder.hpp>

Inheritance diagram for MIDIRotaryEncoder< Sender >:
Collaboration diagram for MIDIRotaryEncoder< Sender >:

Public Member Functions

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

Sender sender
 

Protected Member Functions

 MIDIRotaryEncoder (const EncoderPinList &pins, const MIDICNChannelAddress &address, uint8_t speedMultiply, uint8_t pulsesPerStep, const Sender &sender)
 Construct a new MIDIRotaryEncoder. More...
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Private Attributes

Encoder encoder
 
const MIDICNChannelAddress address
 
const uint8_t speedMultiply
 
const uint8_t pulsesPerStep
 
long previousPosition = 0
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class Sender>
class MIDIRotaryEncoder< Sender >

An abstract class for rotary encoders that send MIDI events.

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

Constructor & Destructor Documentation

◆ MIDIRotaryEncoder()

template<class Sender>
MIDIRotaryEncoder< Sender >::MIDIRotaryEncoder ( const EncoderPinList pins,
const MIDICNChannelAddress address,
uint8_t  speedMultiply,
uint8_t  pulsesPerStep,
const Sender &  sender 
)
inlineprotected

Construct a new MIDIRotaryEncoder.

Todo:
Documentation

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

Member Function Documentation

◆ begin()

template<class Sender>
void MIDIRotaryEncoder< Sender >::begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

template<class Sender>
void MIDIRotaryEncoder< Sender >::update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

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

◆ encoder

template<class Sender>
Encoder MIDIRotaryEncoder< Sender >::encoder
private

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

◆ address

template<class Sender>
const MIDICNChannelAddress MIDIRotaryEncoder< Sender >::address
private

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

◆ speedMultiply

template<class Sender>
const uint8_t MIDIRotaryEncoder< Sender >::speedMultiply
private

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

◆ pulsesPerStep

template<class Sender>
const uint8_t MIDIRotaryEncoder< Sender >::pulsesPerStep
private

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

◆ previousPosition

template<class Sender>
long MIDIRotaryEncoder< Sender >::previousPosition = 0
private

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

◆ sender

template<class Sender>
Sender MIDIRotaryEncoder< Sender >::sender

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