TabularDecView: Implement "hide hidden rows/classes" checkbox
[pulseview.git] / 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 <QColor>
27 #include <QString>
28
29 using std::vector;
30
31 struct srd_proto_data;
32
33 namespace pv {
34 namespace data {
35 namespace decode {
36
37 class Row;
38 class RowData;
39
40 class Annotation
41 {
42 public:
43         typedef uint32_t Class;
44
45 public:
46         Annotation(uint64_t start_sample, uint64_t end_sample,
47                 const vector<QString>* texts, Class ann_class_id, const RowData *data);
48         Annotation(Annotation&& a);
49         Annotation& operator=(Annotation&& a);
50
51         const RowData* row_data() const;
52         const Row* row() const;
53
54         uint64_t start_sample() const;
55         uint64_t end_sample() const;
56         uint64_t length() const;
57
58         Class ann_class_id() const;
59         const QString ann_class_name() const;
60         const QString ann_class_description() const;
61
62         const vector<QString>* annotations() const;
63         const QString longest_annotation() const;
64
65         bool visible() const;
66
67         const QColor color() const;
68         const QColor bright_color() const;
69         const QColor dark_color() const;
70
71         bool operator<(const Annotation &other) const;
72
73 private:
74         uint64_t start_sample_;
75         uint64_t end_sample_;
76         const vector<QString>* texts_;
77         Class ann_class_id_;
78         const RowData* data_;
79 };
80
81 } // namespace decode
82 } // namespace data
83 } // namespace pv
84
85 #endif // PULSEVIEW_PV_VIEW_DECODE_ANNOTATION_HPP