2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #ifndef PULSEVIEW_UTIL_HPP
21 #define PULSEVIEW_UTIL_HPP
26 #include <boost/multiprecision/cpp_dec_float.hpp>
51 /// Returns the exponent that corresponds to a given prefix.
52 int exponent(SIPrefix prefix);
54 /// Timestamp type providing yoctosecond resolution.
55 typedef boost::multiprecision::number<
56 boost::multiprecision::cpp_dec_float<24>,
57 boost::multiprecision::et_off> Timestamp;
60 * Formats a given timestamp with the specified SI prefix.
62 * If 'prefix' is left 'unspecified', the function chooses a prefix so that
63 * the value in front of the decimal point is between 1 and 999.
65 * The default value "s" for the unit argument makes the most sense when
66 * formatting time values, but a different value can be given if the function
67 * is reused to format a value of another quantity.
69 * @param t The value to format.
70 * @param prefix The SI prefix to use.
71 * @param precision The number of digits after the decimal separator.
72 * @param unit The unit of quantity.
73 * @param sign Whether or not to add a sign also for positive numbers.
75 * @return The formatted value.
77 QString format_time_si(const Timestamp& v,
78 SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
79 QString unit = "s", bool sign = true);
82 * Wrapper around 'format_time_si()' that interprets the given 'precision'
83 * value as the number of decimal places if the timestamp would be formatted
84 * without a SI prefix (using 'SIPrefix::none') and adjusts the precision to
85 * match the given 'prefix'
87 * @param t The value to format.
88 * @param prefix The SI prefix to use.
89 * @param precision The number of digits after the decimal separator if the
90 * 'prefix' would be 'SIPrefix::none', see above for more information.
91 * @param unit The unit of quantity.
92 * @param sign Whether or not to add a sign also for positive numbers.
94 * @return The formatted value.
96 QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
97 unsigned precision = 0, QString unit = "s", bool sign = true);
100 * Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format.
102 * "DD" and "HH" are left out if they would be "00" (but if "DD" is generated,
103 * "HH" is also always generated. The "MM:SS" part is always produced, the
104 * number of subsecond digits can be influenced using the 'precision' parameter.
106 * @param t The value to format.
107 * @param precision The number of digits after the decimal separator.
108 * @param sign Whether or not to add a sign also for positive numbers.
110 * @return The formatted value.
112 QString format_time_minutes(const Timestamp& t, signed precision = 0,
118 Q_DECLARE_METATYPE(pv::util::Timestamp)
120 #endif // PULSEVIEW_UTIL_HPP