Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
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.
void disable ()
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
bool isEnabled () const
 Check if this updatable is enabled.
void moveDown ()
 Move down this element in the list.

Main initialization and updating methods

static void beginAll ()
 Begin all enabled instances of this class.
static void updateAll ()
 Update all enabled instances of this class.

Public Member Functions

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

Protected Attributes

BankAddress addresses
AH::IncrementDecrementButtons buttons
const uint8_t multiplier
Updatable< NormalUpdatable > * next
Updatable< NormalUpdatable > * previous

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables

Constructor & Destructor Documentation

◆ MIDIIncrementDecrementButtons()

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

Member Function Documentation

◆ begin()

template<class BankAddress, class RelativeSender, class ResetSender>
void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

template<class BankAddress, class RelativeSender, class ResetSender>
void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

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

◆ send()

template<class BankAddress, class RelativeSender, class ResetSender>
void send ( long delta,
MIDIAddress address )
inline

◆ reset()

template<class BankAddress, class RelativeSender, class ResetSender>
void reset ( )
inline

◆ invert()

template<class BankAddress, class RelativeSender, class ResetSender>
void invert ( )
inline

◆ getButtonsState()

template<class BankAddress, class RelativeSender, class ResetSender>
AH::IncrementDecrementButtons::State getButtonsState ( ) const
inline

◆ beginAll()

template<class T = NormalUpdatable>
void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>
void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 186 of file Updatable.hpp.

◆ enable()

void enable ( )
inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

◆ disable()

void disable ( )
inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 106 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 120 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ addresses

template<class BankAddress, class RelativeSender, class ResetSender>
BankAddress addresses
protected

◆ buttons

template<class BankAddress, class RelativeSender, class ResetSender>
AH::IncrementDecrementButtons buttons
protected

◆ multiplier

template<class BankAddress, class RelativeSender, class ResetSender>
const uint8_t multiplier
protected

◆ relativeSender

template<class BankAddress, class RelativeSender, class ResetSender>
RelativeSender relativeSender

◆ resetSender

template<class BankAddress, class RelativeSender, class ResetSender>
ResetSender resetSender

◆ updatables

DoublyLinkedList<Updatable< NormalUpdatable >> updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable >* next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable >* previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.


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