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