pv/util.hpp

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