]>
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_UTIL_HPP | |
22 | #define PULSEVIEW_UTIL_HPP | |
23 | ||
24 | #include <cmath> | |
25 | ||
26 | #include <boost/multiprecision/cpp_dec_float.hpp> | |
27 | ||
28 | #include <QMetaType> | |
29 | #include <QString> | |
30 | ||
31 | namespace pv { | |
32 | namespace util { | |
33 | ||
34 | enum class TimeUnit { | |
35 | Time = 1, | |
36 | Samples = 2 | |
37 | }; | |
38 | ||
39 | enum class SIPrefix { | |
40 | unspecified = -1, | |
41 | yocto, zepto, | |
42 | atto, femto, pico, | |
43 | nano, micro, milli, | |
44 | none, | |
45 | kilo, mega, giga, | |
46 | tera, peta, exa, | |
47 | zetta, yotta | |
48 | }; | |
49 | ||
50 | /// Returns the exponent that corresponds to a given prefix. | |
51 | int exponent(SIPrefix prefix); | |
52 | ||
53 | /// Timestamp type providing yoctosecond resolution. | |
54 | typedef boost::multiprecision::number< | |
55 | boost::multiprecision::cpp_dec_float<24>, | |
56 | boost::multiprecision::et_off> Timestamp; | |
57 | ||
58 | /** | |
59 | * Formats a given value with the specified SI prefix. | |
60 | * @param v The value to format. | |
61 | * @param unit The unit of quantity. | |
62 | * @param prefix The prefix to use. | |
63 | * @param precision The number of digits after the decimal separator. | |
64 | * @param sign Whether or not to add a sign also for positive numbers. | |
65 | * | |
66 | * @return The formated value. | |
67 | */ | |
68 | QString format_si_value( | |
69 | const Timestamp& v, QString unit, SIPrefix prefix = SIPrefix::unspecified, | |
70 | unsigned precision = 0, bool sign = true); | |
71 | ||
72 | /** | |
73 | * Formats a given time with the specified SI prefix. | |
74 | * @param t The time value in seconds to format. | |
75 | * @param prefix The prefix to use. | |
76 | * @param unit The unit of quantity. | |
77 | * @param precision The number of digits after the decimal separator or period (.). | |
78 | * | |
79 | * @return The formated value. | |
80 | */ | |
81 | QString format_time( | |
82 | const Timestamp& t, SIPrefix prefix = SIPrefix::unspecified, | |
83 | TimeUnit unit = TimeUnit::Time, unsigned precision = 0); | |
84 | ||
85 | /** | |
86 | * Formats a given time value with a SI prefix so that the | |
87 | * value is between 1 and 999. | |
88 | * @param second The time value in seconds to format. | |
89 | * | |
90 | * @return The formated value. | |
91 | */ | |
92 | QString format_second(const Timestamp& second); | |
93 | ||
94 | } // namespace util | |
95 | } // namespace pv | |
96 | ||
97 | Q_DECLARE_METATYPE(pv::util::Timestamp) | |
98 | ||
99 | #endif // PULSEVIEW_UTIL_HPP |