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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef PULSEVIEW_PV_BINDING_INPUTOUTPUT_HPP
  22 #define PULSEVIEW_PV_BINDING_INPUTOUTPUT_HPP
  23
  24 #include <map>
  25 #include <memory>
  26 #include <string>
  27
  28 #include "binding.hpp"
  29
  30 #include <pv/prop/property.hpp>
  31
  32 namespace sigrok {
  33 class Option;
  34 }
  35
  36 namespace pv {
  37 namespace binding {
  38
  39 /**
  40  * A binding of glibmm variants for sigrok input and output options.
  41  */
  42 class InputOutput : public Binding
  43 {
  44 public:
  45         /**
  46          * Constructs a new @c InputOutput binding.
  47          * @param options the map of options to use as a template.
  48          */
  49         InputOutput(
  50                 const std::map<std::string, std::shared_ptr<sigrok::Option>>
  51                         &options);
  52
  53         /**
  54          * Gets the map of selected options.
  55          * @return the options.
  56          */
  57         const std::map<std::string, Glib::VariantBase>& options() const;
  58
  59 private:
  60         /**
  61          * A helper function to bind an option list to and enum property.
  62          * @param name the name of the property.
  63          * @param values the list of values.
  64          * @param getter the getter that will read the values out of the map.
  65          * @param setter the setter that will set the values into the map.
  66          */
  67         std::shared_ptr<prop::Property> bind_enum(const QString &name,
  68                 const std::vector<Glib::VariantBase> &values,
  69                 prop::Property::Getter getter, prop::Property::Setter setter);
  70
  71 private:
  72         /**
  73          * The current map of options.
  74          */
  75         std::map<std::string, Glib::VariantBase> options_;
  76 };
  77
  78 } // binding
  79 } // pv
  80
  81 #endif // PULSEVIEW_PV_BINDING_INPUTOUTPUT_H