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 #include <set>
  26
  27 #include <boost/shared_ptr.hpp>
  28
  29 #include <glib.h>
  30
  31 struct srd_decoder;
  32 struct srd_decoder_inst;
  33 struct srd_channel;
  34 struct srd_session;
  35
  36 namespace pv {
  37
  38 namespace view {
  39 class LogicSignal;
  40 }
  41
  42 namespace data {
  43
  44 class Logic;
  45
  46 namespace decode {
  47
  48 class Decoder
  49 {
  50 public:
  51         Decoder(const srd_decoder *const decoder);
  52
  53         virtual ~Decoder();
  54
  55         const srd_decoder* decoder() const;
  56
  57         bool shown() const;
  58         void show(bool show = true);
  59
  60         const std::map<const srd_channel*,
  61                 boost::shared_ptr<view::LogicSignal> >& channels() const;
  62         void set_probes(std::map<const srd_channel*,
  63                 boost::shared_ptr<view::LogicSignal> > probes);
  64
  65         const std::map<std::string, GVariant*>& options() const;
  66
  67         void set_option(const char *id, GVariant *value);
  68
  69         bool have_required_probes() const;
  70
  71         srd_decoder_inst* create_decoder_inst(
  72                 srd_session *session, int unit_size) const;
  73
  74         std::set< boost::shared_ptr<pv::data::Logic> > get_data();
  75
  76 private:
  77         const srd_decoder *const _decoder;
  78
  79         bool _shown;
  80
  81         std::map<const srd_channel*, boost::shared_ptr<pv::view::LogicSignal> >
  82                 _probes;
  83         std::map<std::string, GVariant*> _options;
  84 };
  85
  86 } // namespace decode
  87 } // namespace data
  88 } // namespace pv
  89
  90 #endif // PULSEVIEW_PV_DATA_DECODE_DECODER_H