pv/data/decode/annotation.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_VIEW_DECODE_ANNOTATION_HPP
  21 #define PULSEVIEW_PV_VIEW_DECODE_ANNOTATION_HPP
  22
  23 #include <cstdint>
  24 #include <vector>
  25
  26 #include <QString>
  27
  28 using std::vector;
  29
  30 struct srd_proto_data;
  31
  32 namespace pv {
  33 namespace data {
  34 namespace decode {
  35
  36 class Row;
  37 class RowData;
  38
  39 class Annotation
  40 {
  41 public:
  42         typedef uint32_t Class;
  43
  44 public:
  45         Annotation(uint64_t start_sample, uint64_t end_sample,
  46                 const vector<QString>* texts, Class ann_class_id, const RowData *data);
  47         Annotation(Annotation&& a);
  48         Annotation& operator=(Annotation&& a);
  49         ~Annotation();
  50
  51         uint64_t start_sample() const;
  52         uint64_t end_sample() const;
  53
  54         Class ann_class_id() const;
  55         const QString ann_class_name() const;
  56
  57         const vector<QString>* annotations() const;
  58         const QString longest_annotation() const;
  59         const Row* row() const;
  60
  61         bool operator<(const Annotation &other) const;
  62
  63 private:
  64         uint64_t start_sample_;
  65         uint64_t end_sample_;
  66         const vector<QString>* texts_;
  67         Class ann_class_id_;
  68         const RowData* data_;
  69 };
  70
  71 } // namespace decode
  72 } // namespace data
  73 } // namespace pv
  74
  75 #endif // PULSEVIEW_PV_VIEW_DECODE_ANNOTATION_HPP