pv/data/decode/decoder.hpp

   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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef PULSEVIEW_PV_DATA_DECODE_DECODER_HPP
  21 #define PULSEVIEW_PV_DATA_DECODE_DECODER_HPP
  22
  23 #include <map>
  24 #include <memory>
  25 #include <set>
  26
  27 #include <glib.h>
  28
  29 using std::map;
  30 using std::set;
  31 using std::shared_ptr;
  32 using std::string;
  33
  34 struct srd_decoder;
  35 struct srd_decoder_inst;
  36 struct srd_channel;
  37 struct srd_session;
  38
  39 namespace pv {
  40
  41 namespace data {
  42
  43 class Logic;
  44 class SignalBase;
  45
  46 namespace decode {
  47
  48 class Decoder
  49 {
  50 public:
  51         Decoder(const srd_decoder *const dec);
  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 map<const srd_channel*,
  61                 shared_ptr<data::SignalBase> >& channels() const;
  62         void set_channels(map<const srd_channel*,
  63                 shared_ptr<data::SignalBase> > channels);
  64
  65         const map<string, GVariant*>& options() const;
  66
  67         void set_option(const char *id, GVariant *value);
  68
  69         bool have_required_channels() const;
  70
  71         srd_decoder_inst* create_decoder_inst(srd_session *session) const;
  72
  73         set< shared_ptr<pv::data::Logic> > get_data();
  74
  75 private:
  76         const srd_decoder *const decoder_;
  77
  78         bool shown_;
  79
  80         map<const srd_channel*, shared_ptr<pv::data::SignalBase> > channels_;
  81         map<string, GVariant*> options_;
  82 };
  83
  84 } // namespace decode
  85 } // namespace data
  86 } // namespace pv
  87
  88 #endif // PULSEVIEW_PV_DATA_DECODE_DECODER_HPP