X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Futil.hpp;h=5466322b738aec51d60904be5df765de45a389d2;hp=572bed31814e6bba0baa670027e1762f04b261c9;hb=3cc9ad7b867853315473df611612c562d562ed8a;hpb=2acdb232d6bb452cfdfaea3ef5218fb4da592329 diff --git a/pv/util.hpp b/pv/util.hpp index 572bed31..5466322b 100644 --- a/pv/util.hpp +++ b/pv/util.hpp @@ -21,7 +21,7 @@ #ifndef PULSEVIEW_UTIL_H #define PULSEVIEW_UTIL_H -#include +#include #include @@ -31,18 +31,33 @@ namespace util { 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