X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Futil.hpp;h=dd7be222b073760b2ec5392ee222617d9717f869;hp=274839f8b7fd5cbd898bb451f032969a20669120;hb=0cbadf1c6a80ec37481ae11ee3cb709eeffda3e7;hpb=2795de2e7fdaeb6e9f672e0dc73dea328f35e585 diff --git a/pv/util.hpp b/pv/util.hpp index 274839f8..dd7be222 100644 --- a/pv/util.hpp +++ b/pv/util.hpp @@ -83,6 +83,24 @@ QString format_time_si(const Timestamp& v, SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0, QString unit = "s", bool sign = true); +/** + * Formats a given value into a representation using SI units. + * + * If 'prefix' is left 'unspecified', the function chooses a prefix so that + * the value in front of the decimal point is between 1 and 999. + * + * @param value The value to format. + * @param prefix The SI prefix to use. + * @param precision The number of digits after the decimal separator. + * @param unit The unit of quantity. + * @param sign Whether or not to add a sign also for positive numbers. + * + * @return The formatted value. + */ +QString format_value_si(double v, + SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0, + QString unit = "", bool sign = true); + /** * Wrapper around 'format_time_si()' that interprets the given 'precision' * value as the number of decimal places if the timestamp would be formatted