CCButtonLatched< NumBanks > Class Template Reference

#include <MIDI_Outputs/Bankable/CCButtonLatched.hpp>

Detailed Description

template<uint8_t NumBanks>
class Bankable::CCButtonLatched< NumBanks >

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.

Template Parameters

NumBanks

The number of banks.

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

Inheritance diagram for CCButtonLatched< NumBanks >:

Collaboration diagram for CCButtonLatched< NumBanks >:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
bool	isEnabled () const
	Check if this updatable is enabled.
void	moveDown ()
	Move down this element in the list.

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class.
static void	updateAll ()
	Update all enabled instances of this class.

Public Member Functions
	CCButtonLatched (BankConfig< NumBanks > config, pin_t pin, MIDIAddress address, const DigitalCCSender &sender={})
	Create a new bankable CCButtonLatched object on the given pin and with address.
void	begin () override
	Initialize this updatable.
void	update () override
	Update this updatable.
bool	toggleState ()
bool	getState () const
void	setState (bool state)
AH::Button::State	getButtonState () const

Public Attributes
DigitalCCSender	sender

Protected Attributes
SingleAddress	address
AH::Button	button
AH::BitArray< NumBanks >	states
Updatable< NormalUpdatable > *	next
Updatable< NormalUpdatable > *	previous

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

Constructor & Destructor Documentation

CCButtonLatched()

template<uint8_t NumBanks>

CCButtonLatched ( BankConfig< NumBanks > config, pin_t pin, MIDIAddress 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 [Cable_1, Cable_16].
sender	The MIDI sender to use.

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

Member Function Documentation

begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

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

update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

toggleState()

bool toggleState ( )

inlineinherited

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

getState()

bool getState ( ) const

inlineinherited

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

setState()

void setState ( bool state )

inlineinherited

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

getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

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

beginAll()

template<class T = NormalUpdatable>

void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also

begin()

Definition at line 182 of file Updatable.hpp.

updateAll()

template<class T = NormalUpdatable>

void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also

update()

Definition at line 186 of file Updatable.hpp.

enable()

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

disable()

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 106 of file Updatable.hpp.

isEnabled()

bool isEnabled ( ) const

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

moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

address

SingleAddress address

protectedinherited

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

button

AH::Button button

protectedinherited

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

states

AH::BitArray<NumBanks> states

protectedinherited

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

sender

DigitalCCSender sender

inherited

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

updatables

DoublyLinkedList<Updatable< NormalUpdatable >> updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

next

Updatable< NormalUpdatable >* next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

previous

Updatable< NormalUpdatable >* previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

---

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

• Bankable/CCButtonLatched.hpp