MIDIButtons< Sender, NUMBER_OF_BUTTONS > Class Template Reference

An abstract class for momentary push buttons that send MIDI events. More...

#include <MIDI_Outputs/Abstract/MIDIButtons.hpp>

Inheritance diagram for MIDIButtons< Sender, NUMBER_OF_BUTTONS >:

Collaboration diagram for MIDIButtons< Sender, NUMBER_OF_BUTTONS >:

Public Member Functions
void	begin () final override
	Initialize this updatable. More...
void	update () final override
	Update this updatable. More...
AH::Button::State	getButtonState (size_t index) const
void	invert ()
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
	MIDIButtons (const Array< AH::Button, NUMBER_OF_BUTTONS > &buttons, const MIDICNChannelAddress &baseAddress, const RelativeMIDICNChannelAddress &incrementAddress, const Sender &sender)
	Construct a new MIDIButtons. More...

Protected Attributes
Updatable< NormalUpdatable > *	next
Updatable< NormalUpdatable > *	previous

Private Attributes
Array< AH::Button, NUMBER_OF_BUTTONS >	buttons
const MIDICNChannelAddress	baseAddress
const RelativeMIDICNChannelAddress	incrementAddress

Static Private Attributes
static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables

Detailed Description

template<class Sender, uint8_t NUMBER_OF_BUTTONS>
class MIDIButtons< Sender, NUMBER_OF_BUTTONS >

An abstract class for momentary push buttons that send MIDI events.

The buttons are debounced.

See also

Button

Definition at line 17 of file Abstract/MIDIButtons.hpp.

Constructor & Destructor Documentation

MIDIButtons()

MIDIButtons ( const Array< AH::Button, NUMBER_OF_BUTTONS > &  buttons, const MIDICNChannelAddress &  baseAddress, const RelativeMIDICNChannelAddress &  incrementAddress, const Sender &  sender  )

inlineprotected

Construct a new MIDIButtons.

Todo:

Documentation

Definition at line 24 of file Abstract/MIDIButtons.hpp.

Member Function Documentation

begin()

void begin ( )

inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

Definition at line 32 of file Abstract/MIDIButtons.hpp.

update()

void update ( )

inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

Definition at line 36 of file Abstract/MIDIButtons.hpp.

getButtonState()

AH::Button::State getButtonState ( size_t  index ) const

inline

Definition at line 49 of file Abstract/MIDIButtons.hpp.

invert()

void invert ( )

inline

Definition at line 54 of file Abstract/MIDIButtons.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 45 of file Updatable.hpp.

enable() [2/4]

static void enable ( Updatable<> *  element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

enable() [3/4]

static void enable ( Updatable<> &  element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

enable() [4/4]

static void enable ( U(&)  array[N] )

inlinestaticinherited

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

disable() [2/4]

static void disable ( Updatable< NormalUpdatable<> > *  element )

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

disable() [3/4]

static void disable ( Updatable< NormalUpdatable<> > &  element )

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

disable() [4/4]

static void disable ( U(&)  array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

isEnabled()

bool 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 69 of file Updatable.hpp.

beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also

begin()

Definition at line 73 of file Updatable.hpp.

updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also

update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

buttons

Array<AH::Button, NUMBER_OF_BUTTONS> buttons

private

Definition at line 61 of file Abstract/MIDIButtons.hpp.

baseAddress

const MIDICNChannelAddress baseAddress

private

Definition at line 62 of file Abstract/MIDIButtons.hpp.

incrementAddress

const RelativeMIDICNChannelAddress incrementAddress

private

Definition at line 63 of file Abstract/MIDIButtons.hpp.

sender

Sender sender

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

updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

---

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

• Abstract/MIDIButtons.hpp