A class of MIDIOutputElements that read the input of a momentary push button, and send out MIDI Controller Change events. More...

#include <MIDI_Outputs/Bankable/CCButtonLatched.hpp>

Inheritance diagram for CCButtonLatched:

Collaboration diagram for CCButtonLatched:

Public Member Functions
	CCButtonLatched (const OutputBankConfig &config, pin_t pin, const MIDICNChannelAddress &address, const DigitalCCSender &sender={})
	Create a new bankable CCButtonLatched object on the given pin and with address. More...

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

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

bool	toggleState ()

bool	getState () const

void	setState (bool state)

AH::Button::State	getButtonState () 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
DigitalCCSender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
SingleAddress	address

AH::Button	button

bool	state

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

Detailed Description

A class of MIDIOutputElements that read the input of a momentary push button, and send out MIDI Controller Change events.

It latches the input, so press once to enable, press again to disable (toggle).

The switch is debounced in software.
This version can be banked.

Definition at line 25 of file Bankable/CCButtonLatched.hpp.

Constructor & Destructor Documentation

◆ CCButtonLatched()

CCButtonLatched	(	const OutputBankConfig &	config,
		pin_t	pin,
		const MIDICNChannelAddress &	address,
		const DigitalCCSender &	sender = `{}`
	)

inline

Create a new bankable CCButtonLatched object on the given pin and with address.

Parameters

config	The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
pin	The digital input pin to read from. The internal pull-up resistor will be enabled.
address	The MIDI address containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
sender	The MIDI sender to use.

Definition at line 45 of file Bankable/CCButtonLatched.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

Definition at line 40 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 41 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ toggleState()

bool toggleState ( )

inlineinherited

Definition at line 47 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ getState()

bool getState ( ) const

inlineinherited

Definition at line 51 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ setState()

void setState ( bool state )

inlineinherited

Definition at line 52 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

Definition at line 63 of file Bankable/Abstract/MIDIButtonLatched.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

◆ address

SingleAddress address

privateinherited

Definition at line 66 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ button

AH::Button button

privateinherited

Definition at line 67 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ state

bool state

privateinherited

Definition at line 68 of file Bankable/Abstract/MIDIButtonLatched.hpp.

◆ sender

DigitalCCSender sender

inherited

Definition at line 71 of file Bankable/Abstract/MIDIButtonLatched.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:

Bankable/CCButtonLatched.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CCButtonLatched()

Member Function Documentation

◆ begin()

◆ update()

◆ toggleState()

◆ getState()

◆ setState()

◆ getButtonState()

◆ 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

◆ address

◆ button

◆ state

◆ sender

◆ updatables

◆ next

◆ previous