Used a std::atomic for StoreSession::_units_stores and _unit_count
[pulseview.git] / pv / util.h
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_UTIL_H
22 #define PULSEVIEW_UTIL_H
23
24 #include <math.h>
25
26 #include <QString>
27
28 namespace pv {
29 namespace util {
30
31 extern const int FirstSIPrefixPower;
32
33 /**
34  * Formats a given time value with the specified SI prefix.
35  * @param t The time value in seconds to format.
36  * @param prefix The number of the prefix, from 0 for 'femto' up to
37  *               8 for 'giga'.
38  * @parma precision The number of digits after the decimal separator.
39  * @param sign Whether or not to add a sign also for positive numbers.
40  *
41  * @return The formated value.
42  */
43 QString format_time(
44         double t, unsigned int prefix,
45         unsigned precision = 0, bool sign = true);
46
47 /**
48  * Formats a given time value with a SI prefix so that the
49  * value is between 1 and 999.
50  * @param second The time value in seconds to format.
51  *
52  * @return The formated value.
53  */
54 QString format_second(double second);
55
56 } // namespace util
57 } // namespace pv
58
59 #endif // PULSEVIEW_UTIL_H