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