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 Member Functions
	CCIncrementDecrementButtons (const AH::IncrementDecrementButtons &buttons, const MIDICNChannelAddress &address, uint8_t multiplier=1, const MIDICNChannelAddress &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 MIDICNChannelAddress &address)

void	reset ()

void	invert ()

AH::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
RelativeCCSender	relativeSender

DigitalNoteSender	resetSender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
AH::IncrementDecrementButtons	buttons

const MIDICNChannelAddress	address

const uint8_t	multiplier

const MIDICNChannelAddress	resetAddress

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

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.

Constructor & Destructor Documentation

◆ CCIncrementDecrementButtons()

CCIncrementDecrementButtons	(	const AH::IncrementDecrementButtons &	buttons,
		const MIDICNChannelAddress &	address,
		uint8_t	multiplier = `1`,
		const MIDICNChannelAddress &	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 [0, 15].
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 [0, 15]. 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 46 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 MIDICNChannelAddress &	address
	)

inlineinherited

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

◆ reset()

void reset ( )

inlineinherited

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

◆ invert()

void invert ( )

inlineinherited

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

◆ getButtonsState()

AH::IncrementDecrementButtons::State getButtonsState ( ) const

inlineinherited

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

AH::IncrementDecrementButtons buttons

privateinherited

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

◆ address

const MIDICNChannelAddress address

privateinherited

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

◆ multiplier

const uint8_t multiplier

privateinherited

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

◆ resetAddress

const MIDICNChannelAddress resetAddress

privateinherited

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

◆ relativeSender

RelativeCCSender relativeSender

inherited

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

◆ resetSender

DigitalNoteSender resetSender

inherited

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

CCIncrementDecrementButtons.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CCIncrementDecrementButtons()

Member Function Documentation

◆ begin()

◆ update()

◆ send()

◆ reset()

◆ invert()

◆ getButtonsState()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ beginAll()

◆ updateAll()

Member Data Documentation

◆ buttons

◆ address

◆ multiplier

◆ resetAddress

◆ relativeSender

◆ resetSender

◆ updatables

◆ next

◆ previous