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

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

#include <MIDIIncrementDecrementButtons.hpp>

Inheritance diagram for MIDIIncrementDecrementButtons< RelativeSender, ResetSender >:
Collaboration diagram for MIDIIncrementDecrementButtons< 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 IncrementDecrementButtons &buttons, const MIDICNChannelAddress &address, uint8_t multiplier, const MIDICNChannelAddress &resetAddress, const RelativeSender &relativeSender, const ResetSender &resetSender)
 Construct a new MIDIIncrementDecrementButtons. More...
 

Protected Attributes

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

Private Attributes

IncrementDecrementButtons buttons
 
const MIDICNChannelAddress address
 
const uint8_t multiplier
 
const MIDICNChannelAddress resetAddress
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class RelativeSender, class ResetSender>
class MIDIIncrementDecrementButtons< RelativeSender, ResetSender >

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

Definition at line 15 of file Abstract/MIDIIncrementDecrementButtons.hpp.

Constructor & Destructor Documentation

◆ MIDIIncrementDecrementButtons()

template<class RelativeSender, class ResetSender>
MIDIIncrementDecrementButtons< RelativeSender, ResetSender >::MIDIIncrementDecrementButtons ( const IncrementDecrementButtons buttons,
const MIDICNChannelAddress address,
uint8_t  multiplier,
const MIDICNChannelAddress resetAddress,
const RelativeSender &  relativeSender,
const ResetSender &  resetSender 
)
inlineprotected

Construct a new MIDIIncrementDecrementButtons.

Todo:
Documentation

Definition at line 22 of file Abstract/MIDIIncrementDecrementButtons.hpp.

Member Function Documentation

◆ begin()

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

Initialize this updatable.

Implements Updatable<>.

Definition at line 33 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ update()

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

Update this updatable.

Implements Updatable<>.

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

◆ send()

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

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

◆ reset()

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

Definition at line 50 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ getButtonsState()

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

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

◆ buttons

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

Definition at line 66 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ address

template<class RelativeSender, class ResetSender>
const MIDICNChannelAddress MIDIIncrementDecrementButtons< RelativeSender, ResetSender >::address
private

Definition at line 67 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ multiplier

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

Definition at line 68 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ resetAddress

template<class RelativeSender, class ResetSender>
const MIDICNChannelAddress MIDIIncrementDecrementButtons< RelativeSender, ResetSender >::resetAddress
private

Definition at line 69 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ relativeSender

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

Definition at line 72 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ resetSender

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

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