.. _program_listing_file_src_pwm_out.h:

Program Listing for File pwm_out.h
==================================

|exhale_lsh| :ref:`Return to documentation for file <file_src_pwm_out.h>` (``src/pwm_out.h``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // BSD 3-Clause License
   //
   // Copyright (c) 2024, Ekumen Inc.
   // All rights reserved.
   //
   // Redistribution and use in source and binary forms, with or without
   // modification, are permitted provided that the following conditions are met:
   //
   // 1. Redistributions of source code must retain the above copyright notice, this
   //    list of conditions and the following disclaimer.
   //
   // 2. Redistributions in binary form must reproduce the above copyright notice,
   //    this list of conditions and the following disclaimer in the documentation
   //    and/or other materials provided with the distribution.
   //
   // 3. Neither the name of the copyright holder nor the names of its
   //    contributors may be used to endorse or promote products derived from
   //    this software without specific prior written permission.
   //
   // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
   // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
   // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
   // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   #pragma once
   
   namespace andino {
   
   class PwmOut {
    public:
     explicit PwmOut(const int gpio_pin) : gpio_pin_(gpio_pin) {}
   
     virtual ~PwmOut() {}
   
     virtual void begin() const = 0;
   
     // TODO(jballoffet): Change this API to expect values from 0 to 100 (%).
     virtual void write(int value) const = 0;
   
    protected:
     const int gpio_pin_;
   };
   
   }  // namespace andino