Add a spin box widget for timestamp values

[pulseview.git] / pv / util.hpp

diff --git a/pv/util.hpp b/pv/util.hpp
index 572bed31814e6bba0baa670027e1762f04b261c9..e9689ec0d6b4248646c91124292495b730be719a 100644 (file)
--- a/pv/util.hpp
+++ b/pv/util.hpp
@@ -18,32 +18,60 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 

-#ifndef PULSEVIEW_UTIL_H
-#define PULSEVIEW_UTIL_H
+#ifndef PULSEVIEW_UTIL_HPP
+#define PULSEVIEW_UTIL_HPP

 
 

-#include <math.h>
+#include <cmath>

 
 

+#include <boost/multiprecision/cpp_dec_float.hpp>
+
+#include <QMetaType>

 #include <QString>
 
 namespace pv {
 namespace util {
 
 #include <QString>
 
 namespace pv {
 namespace util {
 

+enum TimeUnit {
+       Time = 1,
+       Samples = 2
+};
+
+/// Timestamp type providing yoctosecond resolution.
+typedef boost::multiprecision::number<
+       boost::multiprecision::cpp_dec_float<24>,
+       boost::multiprecision::et_off> Timestamp;
+

 extern const int FirstSIPrefixPower;
 
 /**
 extern const int FirstSIPrefixPower;
 
 /**

- * Formats a given time value with the specified SI prefix.
- * @param t The time value in seconds to format.
- * @param prefix The number of the prefix, from 0 for 'femto' up to
- *               8 for 'giga'.
- * @parma precision The number of digits after the decimal separator.
+ * Formats a given value with the specified SI prefix.
+ * @param v The value to format.
+ * @param unit The unit of quantity.
+ * @param prefix The number of the prefix, from 0 for 'yotta' up to
+ *   16 for 'yokto'. If prefix is set to -1, the prefix will be calculated.
+ * @param precision The number of digits after the decimal separator.

  * @param sign Whether or not to add a sign also for positive numbers.
  *
  * @return The formated value.
  */
  * @param sign Whether or not to add a sign also for positive numbers.
  *
  * @return The formated value.
  */

-QString format_time(
-       double t, unsigned int prefix,
+QString format_si_value(
+       const Timestamp& v, QString unit, int prefix = -1,

        unsigned precision = 0, bool sign = true);
 
        unsigned precision = 0, bool sign = true);
 

+/**
+ * Formats a given time with the specified SI prefix.
+ * @param t The time value in seconds to format.
+ * @param prefix The number of the prefix, from 0 for 'yotta' up to
+ *   16 for 'yokto'. If prefix is set to -1, the prefix will be calculated.
+ * @param unit The unit of quantity.
+ * @param precision The number of digits after the decimal separator or period (.).
+ *
+ * @return The formated value.
+ */
+QString format_time(
+       const Timestamp& t, int prefix = -1,
+       TimeUnit unit = Time, unsigned precision = 0);
+

 /**
  * Formats a given time value with a SI prefix so that the
  * value is between 1 and 999.
 /**
  * Formats a given time value with a SI prefix so that the
  * value is between 1 and 999.


@@ -51,9 +79,11 @@ QString format_time(
  *
  * @return The formated value.
  */
  *
  * @return The formated value.
  */

-QString format_second(double second);
+QString format_second(const Timestamp& second);

 
 } // namespace util
 } // namespace pv
 
 
 } // namespace util
 } // namespace pv
 

-#endif // PULSEVIEW_UTIL_H
+Q_DECLARE_METATYPE(pv::util::Timestamp)
+
+#endif // PULSEVIEW_UTIL_HPP