This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
MIDIButtonLatched< Sender > Class Template Reference

A class for momentary buttons and switches that send MIDI events. More...

#include <MIDIButtonLatched.hpp>

Inheritance diagram for MIDIButtonLatched< Sender >:
Collaboration diagram for MIDIButtonLatched< Sender >:

Public Member Functions

void begin () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
bool toggleState ()
 Flip the state (on → off or off → on). More...
 
bool getState () const
 Get the current state. More...
 
void setState (bool state)
 Set the state to the given value. More...
 
Button::State getButtonState () const
 Get the state of the underlying button. More...
 
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

Sender sender
 

Protected Member Functions

 MIDIButtonLatched (pin_t pin, const MIDICNChannelAddress &address, const Sender &sender)
 Create a new MIDIButtonLatched object on the given pin and address. More...
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Private Attributes

Button button
 
const MIDICNChannelAddress address
 
bool state = false
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class Sender>
class MIDIButtonLatched< Sender >

A class for momentary buttons and switches that send MIDI events.

The button is debounced, and the button is latched (press once to enable, press again to disable) (toggle).

See also
Button

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

Constructor & Destructor Documentation

◆ MIDIButtonLatched()

template<class Sender>
MIDIButtonLatched< Sender >::MIDIButtonLatched ( pin_t  pin,
const MIDICNChannelAddress address,
const Sender &  sender 
)
inlineprotected

Create a new MIDIButtonLatched object on the given pin and address.

Parameters
pinThe digital input pin to read from.
The internal pull-up resistor will be enabled.
addressThe MIDI address to send to.
senderThe MIDI sender to use.

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

Member Function Documentation

◆ begin()

template<class Sender>
void MIDIButtonLatched< Sender >::begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

template<class Sender>
void MIDIButtonLatched< Sender >::update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

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

◆ toggleState()

template<class Sender>
bool MIDIButtonLatched< Sender >::toggleState ( )
inline

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

Sends the appropriate MIDI event.

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

◆ getState()

template<class Sender>
bool MIDIButtonLatched< Sender >::getState ( ) const
inline

Get the current state.

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

◆ setState()

template<class Sender>
void MIDIButtonLatched< Sender >::setState ( bool  state)
inline

Set the state to the given value.

Sends the appropriate MIDI event.

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

◆ getButtonState()

template<class Sender>
Button::State MIDIButtonLatched< Sender >::getButtonState ( ) const
inline

Get the state of the underlying button.

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

◆ enable() [1/4]

void Updatable< NormalUpdatable >::enable ( )
inlineinherited

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

Definition at line 40 of file Updatable.hpp.

◆ enable() [2/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> &  element)
inlinestaticinherited

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

static void Updatable< NormalUpdatable >::enable ( U(&)  array[N])
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< NormalUpdatable >::disable ( )
inlineinherited

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

Definition at line 50 of file Updatable.hpp.

◆ disable() [2/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > *  element)
inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > &  element)
inlinestaticinherited

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

static void Updatable< NormalUpdatable >::disable ( U(&)  array[N])
inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< NormalUpdatable >::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 64 of file Updatable.hpp.

◆ beginAll()

static void Updatable< NormalUpdatable >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll()

static void Updatable< NormalUpdatable >::updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

Member Data Documentation

◆ button

template<class Sender>
Button MIDIButtonLatched< Sender >::button
private

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

◆ address

template<class Sender>
const MIDICNChannelAddress MIDIButtonLatched< Sender >::address
private

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

◆ state

template<class Sender>
bool MIDIButtonLatched< Sender >::state = false
private

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

◆ sender

template<class Sender>
Sender MIDIButtonLatched< Sender >::sender

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > Updatable< NormalUpdatable >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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