Implement annotation export for all rows
[pulseview.git] / pv / data / decode / rowdata.hpp
1 /*
2  * This file is part of the PulseView project.
3  *
4  * Copyright (C) 2014 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_ROWDATA_HPP
21 #define PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP
22
23 #include <vector>
24
25 #include <libsigrokdecode/libsigrokdecode.h>
26
27 #include "annotation.hpp"
28
29 using std::vector;
30
31 namespace pv {
32 namespace data {
33 namespace decode {
34
35 class Row;
36
37 class RowData
38 {
39 public:
40         RowData() = default;
41
42 public:
43         uint64_t get_max_sample() const;
44
45         /**
46          * Extracts annotations between the given sample range into a vector.
47          * Note: The annotations are unsorted and only annotations that fully
48          * fit into the sample range are considered.
49          */
50         void get_annotation_subset(
51                 vector<pv::data::decode::Annotation> &dest,
52                 uint64_t start_sample, uint64_t end_sample) const;
53
54         void emplace_annotation(srd_proto_data *pdata, const Row *row);
55
56 private:
57         vector<Annotation> annotations_;
58 };
59
60 }  // namespace decode
61 }  // namespace data
62 }  // namespace pv
63
64 #endif // PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP