LCOV - code coverage report
Current view: top level - src/MIDI_Outputs/Bankable - PCButton.hpp (source / functions) Hit Total Coverage
Test: 19d2efc7037c2e176feca44750a12594c76f466f Lines: 3 3 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/ProgramChangeSender.hpp>
       6             : 
       7             : BEGIN_CS_NAMESPACE
       8             : 
       9             : namespace Bankable {
      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 **Program Change** 
      14             :  *          events.
      15             :  * 
      16             :  * A Program Change event is sent when the button is pressed.  
      17             :  * The button is debounced in software.  
      18             :  * This version can be banked.
      19             :  *
      20             :  * @ingroup BankableMIDIOutputElements
      21             :  */
      22           1 : class PCButton : public MIDIButton<SingleAddress, ProgramChangeSender> {
      23             :   public:
      24             :     /**
      25             :      * @brief   Create a new PCButton object with the given pin, program number
      26             :      *          and channel.
      27             :      * 
      28             :      * @param   config
      29             :      *          The bank configuration to use: the bank to add this element to,
      30             :      *          and whether to change the address, channel or cable number.
      31             :      * @param   pin
      32             :      *          The digital input pin to read from.  
      33             :      *          The internal pull-up resistor will be enabled.
      34             :      * @param   address
      35             :      *          The MIDI address containing the program number [0, 127], 
      36             :      *          channel [CHANNEL_1, CHANNEL_16], and optional cable number 
      37             :      *          [0, 15].
      38             :      * @param   sender
      39             :      *          The MIDI sender to use.
      40             :      */
      41           1 :     PCButton(const OutputBankConfig &config, pin_t pin,
      42             :              const MIDICNChannelAddress &address,
      43             :              const ProgramChangeSender &sender = {})
      44           1 :         : MIDIButton({config, address}, pin, sender) {}
      45             : };
      46             : 
      47             : } // namespace Bankable
      48             : 
      49             : END_CS_NAMESPACE

Generated by: LCOV version 1.14-5-g4ff2ed6