pv/binding/inputoutput.hpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2015 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_BINDING_INPUTOUTPUT_HPP
  21 #define PULSEVIEW_PV_BINDING_INPUTOUTPUT_HPP
  22
  23 #include <map>
  24 #include <memory>
  25 #include <string>
  26
  27 #include "binding.hpp"
  28
  29 #include <pv/prop/property.hpp>
  30
  31 namespace sigrok {
  32 class Option;
  33 }
  34
  35 namespace pv {
  36 namespace binding {
  37
  38 /**
  39  * A binding of glibmm variants for sigrok input and output options.
  40  */
  41 class InputOutput : public Binding
  42 {
  43 public:
  44         /**
  45          * Constructs a new @c InputOutput binding.
  46          * @param options the map of options to use as a template.
  47          */
  48         InputOutput(
  49                 const std::map<std::string, std::shared_ptr<sigrok::Option>>
  50                         &options);
  51
  52         /**
  53          * Gets the map of selected options.
  54          * @return the options.
  55          */
  56         const std::map<std::string, Glib::VariantBase>& options() const;
  57
  58 private:
  59         /**
  60          * A helper function to bind an option list to and enum property.
  61          * @param name the name of the property.
  62          * @param values the list of values.
  63          * @param getter the getter that will read the values out of the map.
  64          * @param setter the setter that will set the values into the map.
  65          */
  66         std::shared_ptr<prop::Property> bind_enum(const QString &name,
  67                 const std::vector<Glib::VariantBase> &values,
  68                 prop::Property::Getter getter, prop::Property::Setter setter);
  69
  70 private:
  71         /**
  72          * The current map of options.
  73          */
  74         std::map<std::string, Glib::VariantBase> options_;
  75 };
  76
  77 } // binding
  78 } // pv
  79
  80 #endif // PULSEVIEW_PV_BINDING_INPUTOUTPUT_H