A class of MIDIOutputElements that read the input of two momentary push buttons to increment or decrement a relative setting using relative MIDI Control Change events. More...

#include <MIDI_Outputs/CCIncrementDecrementButtons.hpp>

Inheritance diagram for CCIncrementDecrementButtons:

Collaboration diagram for CCIncrementDecrementButtons:

Public Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
	CCIncrementDecrementButtons (const AH::IncrementDecrementButtons &buttons, const MIDIAddress &address, uint8_t multiplier=1, const MIDIAddress &resetNote={}, const RelativeCCSender &relativeSender={}, const DigitalNoteSender &resetSender={})
	Construct a new CCIncrementDecrementButtons object. More...

void	begin () override
	Initialize this updatable. More...

void	update () override
	Update this updatable. More...

void	send (long delta, const MIDIAddress &address)

void	reset ()

void	invert ()

AH::IncrementDecrementButtons::State	getButtonsState () const

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
RelativeCCSender	relativeSender

DigitalNoteSender	resetSender

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
AH::IncrementDecrementButtons	buttons

const MIDIAddress	address

const uint8_t	multiplier

const MIDIAddress	resetAddress

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer 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 LockGuard &) const
	Check if this updatable is enabled. More...

bool	isEnabled ()
	Check if this updatable is enabled. More...

void	moveDown (const LockGuard &)
	Move down this element in the list. 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...

Detailed Description

A class of MIDIOutputElements that read the input of two momentary push buttons to increment or decrement a relative setting using relative MIDI Control Change events.

An optional note number can be provided to reset the setting.

This version cannot be banked.

Examples: CCIncrementDecrementButtons.ino.

Definition at line 19 of file CCIncrementDecrementButtons.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ CCIncrementDecrementButtons()

CCIncrementDecrementButtons	(	const AH::IncrementDecrementButtons &	buttons,
		const MIDIAddress &	address,
		uint8_t	multiplier = `1`,
		const MIDIAddress &	resetNote = `{}`,
		const RelativeCCSender &	relativeSender = `{}`,
		const DigitalNoteSender &	resetSender = `{}`
	)

inline

Construct a new CCIncrementDecrementButtons object.

Parameters

buttons	The pins with the increment and decrement buttons connected. The internal pull-up resistors will be enabled.
address	The address to use for the relative events, containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16].
multiplier	The multiplier for the relative events. When setting it to 2, it will scroll twice as fast, for example.
resetNote	The MIDI address to use to reset the setting, containing the note number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16]. It will be triggered when the increment and decrement buttons are pressed simultaneously.
relativeSender	The MIDI sender to use for the relative events.
resetSender	The MIDI sender to use for reset events.

Definition at line 47 of file CCIncrementDecrementButtons.hpp.

Member Function Documentation

◆ begin()

void begin

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ send()

void send	(	long	delta,
		const MIDIAddress &	address
	)

inlineinherited

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

◆ reset()

void reset

inlineinherited

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

◆ invert()

void invert

inlineinherited

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

◆ getButtonsState()

AH::IncrementDecrementButtons::State getButtonsState

inlineinherited

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

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.