]> sigrok.org Git - pulseview.git/blob - pv/data/decode/annotation.hpp
Annotation: Use special type for the class, not plain int
[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 <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 Annotation
37 {
38 public:
39         typedef uint32_t Class;
40
41 public:
42         Annotation(const srd_proto_data *const pdata);
43
44         uint64_t start_sample() const;
45         uint64_t end_sample() const;
46         Class ann_class() const;
47         const vector<QString>& annotations() const;
48
49 private:
50         uint64_t start_sample_;
51         uint64_t end_sample_;
52         Class ann_class_;
53         vector<QString> annotations_;
54 };
55
56 } // namespace decode
57 } // namespace data
58 } // namespace pv
59
60 #endif // PULSEVIEW_PV_VIEW_DECODE_ANNOTATION_HPP