]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the PulseView project. | |
3 | * | |
4 | * Copyright (C) 2012 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, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
19 | */ | |
20 | ||
21 | #ifndef PULSEVIEW_PV_DATA_SNAPSHOT_H | |
22 | #define PULSEVIEW_PV_DATA_SNAPSHOT_H | |
23 | ||
24 | #include <libsigrok/libsigrok.h> | |
25 | ||
26 | #include <boost/thread.hpp> | |
27 | ||
28 | namespace pv { | |
29 | namespace data { | |
30 | ||
31 | class Snapshot | |
32 | { | |
33 | public: | |
34 | Snapshot(int unit_size); | |
35 | ||
36 | virtual ~Snapshot(); | |
37 | ||
38 | uint64_t get_sample_count() const; | |
39 | ||
40 | int unit_size() const; | |
41 | ||
42 | /** | |
43 | * @brief Increase the capacity of the snapshot. | |
44 | * | |
45 | * Increasing the capacity allows samples to be appended without needing | |
46 | * to reallocate memory. | |
47 | * | |
48 | * For the best efficiency @c set_capacity() should be called once before | |
49 | * @c append_data() is called to set up the snapshot with the expected number | |
50 | * of samples that will be appended in total. | |
51 | * | |
52 | * @note The capacity will automatically be increased when @c append_data() | |
53 | * is called if there is not enough capacity in the buffer to store the samples. | |
54 | * | |
55 | * @param[in] new_capacity The new capacity of the snapshot. If this value is | |
56 | * smaller or equal than the current capacity then the method has no effect. | |
57 | */ | |
58 | void set_capacity(uint64_t new_capacity); | |
59 | ||
60 | /** | |
61 | * @brief Get the current capacity of the snapshot. | |
62 | * | |
63 | * The capacity can be increased by calling @c set_capacity(). | |
64 | * | |
65 | * @return The current capacity of the snapshot. | |
66 | */ | |
67 | uint64_t capacity() const; | |
68 | ||
69 | protected: | |
70 | void append_data(void *data, uint64_t samples); | |
71 | ||
72 | protected: | |
73 | mutable boost::recursive_mutex _mutex; | |
74 | void *_data; | |
75 | uint64_t _sample_count; | |
76 | uint64_t _capacity; | |
77 | int _unit_size; | |
78 | }; | |
79 | ||
80 | } // namespace data | |
81 | } // namespace pv | |
82 | ||
83 | #endif // PULSEVIEW_PV_DATA_SNAPSHOT_H |