]>
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 | #ifndef Q_MOC_RUN | |
27 | #include <boost/multiprecision/cpp_dec_float.hpp> | |
28 | #endif | |
29 | ||
30 | #include <QMetaType> | |
31 | #include <QString> | |
32 | ||
33 | namespace pv { | |
34 | namespace util { | |
35 | ||
36 | enum class TimeUnit { | |
37 | Time = 1, | |
38 | Samples = 2 | |
39 | }; | |
40 | ||
41 | enum class SIPrefix { | |
42 | unspecified = -1, | |
43 | yocto, zepto, | |
44 | atto, femto, pico, | |
45 | nano, micro, milli, | |
46 | none, | |
47 | kilo, mega, giga, | |
48 | tera, peta, exa, | |
49 | zetta, yotta | |
50 | }; | |
51 | ||
52 | /// Returns the exponent that corresponds to a given prefix. | |
53 | int exponent(SIPrefix prefix); | |
54 | ||
55 | /// Timestamp type providing yoctosecond resolution. | |
56 | typedef boost::multiprecision::number< | |
57 | boost::multiprecision::cpp_dec_float<24>, | |
58 | boost::multiprecision::et_off> Timestamp; | |
59 | ||
60 | /** | |
61 | * Formats a given timestamp with the specified SI prefix. | |
62 | * | |
63 | * If 'prefix' is left 'unspecified', the function chooses a prefix so that | |
64 | * the value in front of the decimal point is between 1 and 999. | |
65 | * | |
66 | * The default value "s" for the unit argument makes the most sense when | |
67 | * formatting time values, but a different value can be given if the function | |
68 | * is reused to format a value of another quantity. | |
69 | * | |
70 | * @param t The value to format. | |
71 | * @param prefix The SI prefix to use. | |
72 | * @param precision The number of digits after the decimal separator. | |
73 | * @param unit The unit of quantity. | |
74 | * @param sign Whether or not to add a sign also for positive numbers. | |
75 | * | |
76 | * @return The formated value. | |
77 | */ | |
78 | QString format_time_si( | |
79 | const Timestamp& t, | |
80 | SIPrefix prefix = SIPrefix::unspecified, | |
81 | unsigned precision = 0, | |
82 | QString unit = "s", | |
83 | bool sign = true); | |
84 | ||
85 | /** | |
86 | * Wrapper around 'format_time_si()' that interpretes the given 'precision' | |
87 | * value as the number of decimal places if the timestamp would be formatted | |
88 | * without a SI prefix (using 'SIPrefix::none') and adjustes the precision to | |
89 | * match the given 'prefix' | |
90 | * | |
91 | * @param t The value to format. | |
92 | * @param prefix The SI prefix to use. | |
93 | * @param precision The number of digits after the decimal separator if the | |
94 | * 'prefix' would be 'SIPrefix::none', see above for more information. | |
95 | * @param unit The unit of quantity. | |
96 | * @param sign Whether or not to add a sign also for positive numbers. | |
97 | * | |
98 | * @return The formated value. | |
99 | */ | |
100 | QString format_time_si_adjusted( | |
101 | const Timestamp& t, | |
102 | SIPrefix prefix, | |
103 | unsigned precision = 0, | |
104 | QString unit = "s", | |
105 | bool sign = true); | |
106 | ||
107 | /** | |
108 | * Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format. | |
109 | * | |
110 | * "DD" and "HH" are left out if they would be "00" (but if "DD" is generated, | |
111 | * "HH" is also always generated. The "MM:SS" part is always produced, the | |
112 | * number of subsecond digits can be influenced using the 'precision' parameter. | |
113 | * | |
114 | * @param t The value to format. | |
115 | * @param precision The number of digits after the decimal separator. | |
116 | * @param sign Whether or not to add a sign also for positive numbers. | |
117 | * | |
118 | * @return The formated value. | |
119 | */ | |
120 | QString format_time_minutes( | |
121 | const Timestamp& t, | |
122 | signed precision = 0, | |
123 | bool sign = true); | |
124 | ||
125 | } // namespace util | |
126 | } // namespace pv | |
127 | ||
128 | Q_DECLARE_METATYPE(pv::util::Timestamp) | |
129 | ||
130 | #endif // PULSEVIEW_UTIL_HPP |