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, 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 TimeUnit {
  35         Time = 1,
  36         Samples = 2
  37 };
  38
  39 /// Timestamp type providing yoctosecond resolution.
  40 typedef boost::multiprecision::number<
  41         boost::multiprecision::cpp_dec_float<24>,
  42         boost::multiprecision::et_off> Timestamp;
  43
  44 extern const int FirstSIPrefixPower;
  45
  46 /**
  47  * Formats a given value with the specified SI prefix.
  48  * @param v The value to format.
  49  * @param unit The unit of quantity.
  50  * @param prefix The number of the prefix, from 0 for 'yotta' up to
  51  *   16 for 'yokto'. If prefix is set to -1, the prefix will be calculated.
  52  * @param precision The number of digits after the decimal separator.
  53  * @param sign Whether or not to add a sign also for positive numbers.
  54  *
  55  * @return The formated value.
  56  */
  57 QString format_si_value(
  58         const Timestamp& v, QString unit, int prefix = -1,
  59         unsigned precision = 0, bool sign = true);
  60
  61 /**
  62  * Formats a given time with the specified SI prefix.
  63  * @param t The time value in seconds to format.
  64  * @param prefix The number of the prefix, from 0 for 'yotta' up to
  65  *   16 for 'yokto'. If prefix is set to -1, the prefix will be calculated.
  66  * @param unit The unit of quantity.
  67  * @param precision The number of digits after the decimal separator or period (.).
  68  *
  69  * @return The formated value.
  70  */
  71 QString format_time(
  72         const Timestamp& t, int prefix = -1,
  73         TimeUnit unit = Time, unsigned precision = 0);
  74
  75 /**
  76  * Formats a given time value with a SI prefix so that the
  77  * value is between 1 and 999.
  78  * @param second The time value in seconds to format.
  79  *
  80  * @return The formated value.
  81  */
  82 QString format_second(const Timestamp& second);
  83
  84 } // namespace util
  85 } // namespace pv
  86
  87 Q_DECLARE_METATYPE(pv::util::Timestamp)
  88
  89 #endif // PULSEVIEW_UTIL_HPP