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 #include <vector>
  27
  28 #include <glib.h>
  29
  30 using std::map;
  31 using std::set;
  32 using std::shared_ptr;
  33 using std::string;
  34 using std::vector;
  35
  36 struct srd_decoder;
  37 struct srd_decoder_inst;
  38 struct srd_channel;
  39 struct srd_session;
  40
  41 namespace pv {
  42
  43 namespace data {
  44
  45 struct DecodeChannel;
  46 class Logic;
  47 class SignalBase;
  48
  49 namespace decode {
  50
  51 class Decoder
  52 {
  53 public:
  54         Decoder(const srd_decoder *const dec);
  55
  56         virtual ~Decoder();
  57
  58         const srd_decoder* decoder() const;
  59
  60         bool shown() const;
  61         void show(bool show = true);
  62
  63         const vector<data::DecodeChannel*>& channels() const;
  64         void set_channels(vector<data::DecodeChannel*> channels);
  65
  66         const map<string, GVariant*>& options() const;
  67
  68         void set_option(const char *id, GVariant *value);
  69
  70         bool have_required_channels() const;
  71
  72         srd_decoder_inst* create_decoder_inst(srd_session *session) const;
  73
  74 private:
  75         const srd_decoder *const decoder_;
  76
  77         bool shown_;
  78
  79         vector<data::DecodeChannel*> channels_;
  80         map<string, GVariant*> options_;
  81 };
  82
  83 } // namespace decode
  84 } // namespace data
  85 } // namespace pv
  86
  87 #endif // PULSEVIEW_PV_DATA_DECODE_DECODER_HPP