NoteButtonLatched Class Reference

#include <MIDI_Outputs/NoteButtonLatched.hpp>

Detailed Description

A class of MIDIOutputElements that read the input of a momentary push button or switch, and send out MIDI Note events.

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

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

Definition at line 22 of file NoteButtonLatched.hpp.

Inheritance diagram for NoteButtonLatched:

Collaboration diagram for NoteButtonLatched:

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.
static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
template<class U , size_t N>
static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
template<class U , size_t N>
static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

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
	NoteButtonLatched (pin_t pin, MIDIAddress address, uint8_t velocity=0x7F)
	Create a new NoteButtonLatched object on the given pin and with address.
void	setVelocity (uint8_t velocity)
	Set the velocity of the MIDI Note events.
uint8_t	getVelocity () const
	Get the velocity of the MIDI Note events.
void	begin () final override
	Initialize this updatable.
void	update () final override
	Update this updatable.
bool	toggleState ()
	Flip the state (on → off or off → on).
bool	getState () const
	Get the current state.
void	setState (bool state)
	Set the state to the given value.
void	invert ()
AH::Button::State	getButtonState () const
	Get the state of the underlying button.
MIDIAddress	getAddress () const
	Get the MIDI address.
void	setAddressUnsafe (MIDIAddress address)
	Set the MIDI address.

Public Attributes
DigitalNoteSender	sender

Protected Attributes
Derived *	next
Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Private Attributes
AH::Button	button
const MIDIAddress	address
bool	state

Constructor & Destructor Documentation

NoteButtonLatched()

NoteButtonLatched ( pin_t pin, MIDIAddress address, uint8_t velocity = 0x7F )

inline

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

Parameters

pin	The digital input pin to read from. The internal pull-up resistor will be enabled.
address	The MIDI address containing the note number [0, 127], channel [Channel_1, Channel_16], and optional cable number [Cable_1, Cable_16].
velocity	The velocity of the MIDI Note events.

Definition at line 38 of file NoteButtonLatched.hpp.

Member Function Documentation

setVelocity()

void setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 46 of file NoteButtonLatched.hpp.

getVelocity()

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 48 of file NoteButtonLatched.hpp.

begin()

void begin ( )

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 38 of file Abstract/MIDIButtonLatched.hpp.

update()

void update ( )

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 39 of file Abstract/MIDIButtonLatched.hpp.

toggleState()

bool toggleState ( )

inlineinherited

Flip the state (on → off or off → on).

Sends the appropriate MIDI event.

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

getState()

bool getState ( ) const

inlineinherited

Get the current state.

Definition at line 53 of file Abstract/MIDIButtonLatched.hpp.

setState()

void setState ( bool state )

inlineinherited

Set the state to the given value.

Sends the appropriate MIDI event.

Definition at line 57 of file Abstract/MIDIButtonLatched.hpp.

invert()

void invert ( )

inlineinherited

See also

AH::Button::invert()

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

getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

Get the state of the underlying button.

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

getAddress()

MIDIAddress getAddress ( ) const

inlineinherited

Get the MIDI address.

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

setAddressUnsafe()

void setAddressUnsafe ( MIDIAddress address )

inlineinherited

Set the MIDI address.

Has unexpected consequences if used while the button is active. Use banks if you need to support that.

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

beginAll()

template<class T = NormalUpdatable>

static 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>

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also

update()

Definition at line 186 of file Updatable.hpp.

enable() [1/4]

template<class Derived >

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.

enable() [2/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

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

Definition at line 125 of file Updatable.hpp.

enable() [3/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

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

Definition at line 127 of file Updatable.hpp.

enable() [4/4]

template<class Derived >

template<class U , size_t N>

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

inlinestaticinherited

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

Definition at line 130 of file Updatable.hpp.

disable() [1/4]

template<class Derived >

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.

disable() [2/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

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

Definition at line 136 of file Updatable.hpp.

disable() [3/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

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

Definition at line 138 of file Updatable.hpp.

disable() [4/4]

template<class Derived >

template<class U , size_t N>

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

inlinestaticinherited

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

Definition at line 141 of file Updatable.hpp.

isEnabled()

template<class Derived >

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()

template<class Derived >

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

button

AH::Button button

privateinherited

Definition at line 75 of file Abstract/MIDIButtonLatched.hpp.

address

const MIDIAddress address

privateinherited

Definition at line 76 of file Abstract/MIDIButtonLatched.hpp.

state

bool state

privateinherited

Definition at line 77 of file Abstract/MIDIButtonLatched.hpp.

sender

DigitalNoteSender sender

inherited

Definition at line 80 of file Abstract/MIDIButtonLatched.hpp.

updatables

template<class Derived >

DoublyLinkedList< Derived > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

next

Derived * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

previous

Derived * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

---

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

• NoteButtonLatched.hpp