* 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 <QString>
extern const int FirstSIPrefixPower;
/**
- * Formats a given time value with the specified SI prefix.
+ * 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 'femto' up to
+ * 8 for 'giga'. 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.
+ */
+QString format_si_value(
+ double v, QString unit, int prefix = -1,
+ 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 'femto' up to
- * 8 for 'giga'.
- * @parma precision The number of digits after the decimal separator.
+ * 8 for 'giga'. 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.
* @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,
- unsigned precision = 0, bool sign = true);
+ double t, int prefix = -1, unsigned precision = 0, bool sign = true);
/**
* Formats a given time value with a SI prefix so that the
} // namespace util
} // namespace pv
-#endif // PULSEVIEW_UTIL_H
+#endif // PULSEVIEW_UTIL_HPP