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
Bankable::MIDIRotaryEncoder< Sender > Class Template Reference

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

#include <MIDIRotaryEncoder.hpp>

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

Public Member Functions

void begin () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
RelativeMIDICNChannelAddress getAddressOffset () const
 Get the offset relative to the base address. More...
 
setting_t getRawBankSetting () const
 Get the actual bank setting (no matter whether the element is locked or not). More...
 
setting_t getSelection () const
 Get the bank setting. More...
 
void lock ()
 Lock the bank setting. More...
 
void unlock ()
 Unlock the bank 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

Sender sender
 

Protected Member Functions

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

Protected Attributes

const OutputBankbank
 
Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Private Attributes

Encoder encoder
 
const MIDICNChannelAddress address
 
const uint8_t speedMultiply
 
const uint8_t pulsesPerStep
 
long previousPosition = 0
 
const BankType type
 
setting_t lockedSetting = UNLOCKED
 

Static Private Attributes

constexpr static setting_t UNLOCKED = NO_SETTING
 
static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class Sender>
class Bankable::MIDIRotaryEncoder< Sender >

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

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

Constructor & Destructor Documentation

◆ MIDIRotaryEncoder()

template<class Sender>
Bankable::MIDIRotaryEncoder< Sender >::MIDIRotaryEncoder ( const OutputBankConfig config,
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 31 of file Bankable/Abstract/MIDIRotaryEncoder.hpp.

Member Function Documentation

◆ begin()

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

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

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

Update this updatable.

Implements Updatable<>.

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

◆ getAddressOffset()

RelativeMIDICNChannelAddress BankableMIDIOutput::getAddressOffset ( ) const
inlineinherited

Get the offset relative to the base address.

Definition at line 111 of file BankableMIDIOutput.hpp.

◆ getRawBankSetting()

setting_t BankableMIDIOutput_Base::getRawBankSetting ( ) const
inlineinherited

Get the actual bank setting (no matter whether the element is locked or not).

Definition at line 26 of file BankableMIDIOutput.hpp.

◆ getSelection()

setting_t BankableMIDIOutput_Base::getSelection ( ) const
inlineinherited

Get the bank setting.

If the element is locked, the bank setting from the moment it was locked is returned.

Definition at line 34 of file BankableMIDIOutput.hpp.

◆ lock()

void BankableMIDIOutput_Base::lock ( )
inlineinherited

Lock the bank setting.

As long as it's locked, getSelection will return the current setting, independent from the actual bank setting.

Definition at line 44 of file BankableMIDIOutput.hpp.

◆ unlock()

void BankableMIDIOutput_Base::unlock ( )
inlineinherited

Unlock the bank setting.

After unlocking, getSelection will return the actual bank setting again.

Definition at line 55 of file BankableMIDIOutput.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 Bankable::MIDIRotaryEncoder< Sender >::encoder
private

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

◆ address

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

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

◆ speedMultiply

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

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

◆ pulsesPerStep

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

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

◆ previousPosition

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

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

◆ sender

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

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

◆ type

const BankType BankableMIDIOutput::type
privateinherited

Definition at line 122 of file BankableMIDIOutput.hpp.

◆ bank

const OutputBank& BankableMIDIOutput_Base::bank
protectedinherited

Definition at line 58 of file BankableMIDIOutput.hpp.

◆ UNLOCKED

constexpr static setting_t BankableMIDIOutput_Base::UNLOCKED = NO_SETTING
staticconstexprprivateinherited

Definition at line 61 of file BankableMIDIOutput.hpp.

◆ lockedSetting

setting_t BankableMIDIOutput_Base::lockedSetting = UNLOCKED
privateinherited

Definition at line 62 of file BankableMIDIOutput.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: