Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender > Class Template Reference

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

Detailed Description

template<class BankAddress, class RelativeSender, class ResetSender>
class Bankable::MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >

An abstract class for two buttons that send incremental MIDI events.

Definition at line 19 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

+ Inheritance diagram for MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >:
+ Collaboration diagram for MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >:

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

void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
void send (long delta, MIDIAddress address)
 
void reset ()
 
void invert ()
 
AH::IncrementDecrementButtons::State getButtonsState () const
 

Public Attributes

RelativeSender relativeSender
 
ResetSender resetSender
 

Protected Member Functions

 MIDIIncrementDecrementButtons (BankAddress addresses, const AH::IncrementDecrementButtons &buttons, uint8_t multiplier, const RelativeSender &relativeSender, const ResetSender &resetSender)
 Construct a new MIDIIncrementDecrementButtons. More...
 

Protected Attributes

BankAddress addresses
 
AH::IncrementDecrementButtons buttons
 
const uint8_t multiplier
 
Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Constructor & Destructor Documentation

◆ MIDIIncrementDecrementButtons()

MIDIIncrementDecrementButtons ( BankAddress  addresses,
const AH::IncrementDecrementButtons buttons,
uint8_t  multiplier,
const RelativeSender &  relativeSender,
const ResetSender &  resetSender 
)
inlineprotected

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 35 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ update()

void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ send()

void send ( long  delta,
MIDIAddress  address 
)
inline

◆ reset()

void reset ( )
inline

◆ invert()

void invert ( )
inline

◆ getButtonsState()

AH::IncrementDecrementButtons::State getButtonsState ( ) const
inline

◆ 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

◆ addresses

BankAddress addresses
protected

◆ buttons

AH::IncrementDecrementButtons buttons
protected

◆ multiplier

const uint8_t multiplier
protected

◆ relativeSender

RelativeSender relativeSender

◆ resetSender

ResetSender resetSender

◆ 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: