LCOV - code coverage report
Current view: top level - src/MIDI_Outputs/ManyAddresses - NoteButton.hpp (source / functions) Hit Total Coverage
Test: 19d2efc7037c2e176feca44750a12594c76f466f Lines: 4 4 100.0 %
Date: 2019-11-24 14:50:27 Functions: 2 3 66.7 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : #pragma once
       2             : 
       3             : #include <Banks/BankAddresses.hpp>
       4             : #include <MIDI_Outputs/Bankable/Abstract/MIDIButton.hpp>
       5             : #include <MIDI_Senders/DigitalNoteSender.hpp>
       6             : 
       7             : BEGIN_CS_NAMESPACE
       8             : namespace Bankable {
       9             : namespace ManyAddresses {
      10             : 
      11             : /**
      12             :  * @brief   A class of MIDIOutputElement%s that read the input of a **momentary
      13             :  *          push button or switch**, and send out MIDI **Note** events.
      14             :  * 
      15             :  * A Note On event is sent when the button is pressed, and a Note Off
      16             :  * event is sent when the button is released.  
      17             :  * The button is debounced in software.  
      18             :  * This version can be banked using an arbitrary list of alternative
      19             :  * addresses.
      20             :  *          
      21             :  * @tparam  N
      22             :  *          The number of variants/alternative addresses the element has.
      23             :  *
      24             :  * @ingroup ManyAddressesMIDIOutputElements
      25             :  */
      26             : template <setting_t N>
      27           1 : class NoteButton
      28             :     : public Bankable::MIDIButton<ManyAddresses<N>, DigitalNoteSender> {
      29             :   public:
      30             :     /**
      31             :      * @brief   Create a new Bankable NoteButton object with the given bank 
      32             :      *          configuration, button pin, and address.
      33             :      *
      34             :      * @param   bank
      35             :      *          The bank that selects the address to use.
      36             :      * @param   pin
      37             :      *          The digital input pin with the button connected.  
      38             :      *          The internal pull-up resistor will be enabled.
      39             :      * @param   addresses
      40             :      *          The list of MIDI addresses containing the note number 
      41             :      *          [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable 
      42             :      *          number [0, 15].
      43             :      * @param   velocity
      44             :      *          The velocity of the MIDI Note events.
      45             :      * 
      46             :      * @ingroup MIDIOutputElementConstructors
      47             :      */
      48           1 :     NoteButton(const Bank<N> &bank, pin_t pin,
      49             :                const Array<MIDICNChannelAddress, N> &addresses,
      50             :                uint8_t velocity = 0x7F)
      51           1 :         : MIDIButton<ManyAddresses<N>, DigitalNoteSender>{
      52           2 :               {bank, addresses}, pin, {velocity}} {}
      53             : };
      54             : 
      55             : } // namespace ManyAddresses
      56             : } // namespace Bankable
      57             : 
      58             : END_CS_NAMESPACE

Generated by: LCOV version 1.14-5-g4ff2ed6