pv/data/decode/decoder.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2013 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_DATA_DECODE_DECODER_H
  22 #define PULSEVIEW_PV_DATA_DECODE_DECODER_H
  23
  24 #include <map>
  25
  26 #include <boost/shared_ptr.hpp>
  27
  28 #include <glib.h>
  29
  30 struct srd_decoder;
  31 struct srd_decoder_inst;
  32 struct srd_probe;
  33 struct srd_session;
  34
  35 namespace pv {
  36
  37 namespace view {
  38 class LogicSignal;
  39 }
  40
  41 namespace data {
  42 namespace decode {
  43
  44 class Decoder
  45 {
  46 public:
  47         Decoder(const srd_decoder *const decoder);
  48
  49         virtual ~Decoder();
  50
  51         const srd_decoder* decoder() const;
  52
  53         bool shown() const;
  54         void show(bool show = true);
  55
  56         const std::map<const srd_probe*,
  57                 boost::shared_ptr<view::LogicSignal> >& probes() const;
  58         void set_probes(std::map<const srd_probe*,
  59                 boost::shared_ptr<view::LogicSignal> > probes);
  60
  61         const std::map<std::string, GVariant*>& options() const;
  62
  63         void set_option(const char *id, GVariant *value);
  64
  65         bool have_required_probes() const;
  66
  67         srd_decoder_inst* create_decoder_inst(
  68                 srd_session *const session) const;
  69
  70 private:
  71         const srd_decoder *const _decoder;
  72
  73         bool _shown;
  74
  75         std::map<const srd_probe*, boost::shared_ptr<pv::view::LogicSignal> >
  76                 _probes;
  77         std::map<std::string, GVariant*> _options;
  78 };
  79
  80 } // namespace decode
  81 } // namespace data
  82 } // namespace pv
  83
  84 #endif // PULSEVIEW_PV_DATA_DECODE_DECODER_H