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::MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender > Class Template Reference

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

#include <MIDIIncrementDecrementButtons.hpp>

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

Public Member Functions

void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
void send (long delta, const MIDICNChannelAddress &address)
 
void reset ()
 
IncrementDecrementButtons::State getButtonsState () const
 
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

RelativeSender relativeSender
 
ResetSender resetSender
 

Protected Member Functions

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

Protected Attributes

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

Private Attributes

BankAddress addresses
 
IncrementDecrementButtons buttons
 
const uint8_t multiplier
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

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.

Todo:
Combine RelativeSender and ResetSender?

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

Constructor & Destructor Documentation

◆ MIDIIncrementDecrementButtons()

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

Construct a new MIDIIncrementDecrementButtons.

Todo:
Documentation

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

Member Function Documentation

◆ begin()

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

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

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

Update this updatable.

Implements Updatable<>.

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

◆ send()

template<class BankAddress, class RelativeSender, class ResetSender>
void Bankable::MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >::send ( long  delta,
const MIDICNChannelAddress address 
)
inline

◆ reset()

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

◆ getButtonsState()

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

◆ 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

◆ addresses

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

◆ buttons

template<class BankAddress, class RelativeSender, class ResetSender>
IncrementDecrementButtons Bankable::MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >::buttons
private

◆ multiplier

template<class BankAddress, class RelativeSender, class ResetSender>
const uint8_t Bankable::MIDIIncrementDecrementButtons< BankAddress, RelativeSender, ResetSender >::multiplier
private

◆ relativeSender

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

◆ resetSender

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

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