Make the analog value voltage display more sane

[pulseview.git] / pv / util.hpp

diff --git a/pv/util.hpp b/pv/util.hpp
index bc71624bf3109fc2cb498778e943ac7acb3480f0..fab29a14f05ac21ea90b88d37088c2f9274a278f 100644 (file)
--- a/pv/util.hpp
+++ b/pv/util.hpp
@@ -17,10 +17,12 @@
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef PULSEVIEW_UTIL_HPP
-#define PULSEVIEW_UTIL_HPP
+#ifndef PULSEVIEW_PV_UTIL_HPP
+#define PULSEVIEW_PV_UTIL_HPP
 
 #include <cmath>
+#include <string>
+#include <vector>
 
 #ifndef Q_MOC_RUN
 #include <boost/multiprecision/cpp_dec_float.hpp>
@@ -29,10 +31,14 @@
 #include <QMetaType>
 #include <QString>
 
+using std::string;
+using std::vector;
+
 namespace pv {
 namespace util {
 
 enum class TimeUnit {
+       None = 0,
        Time = 1,
        Samples = 2
 };
@@ -56,6 +62,11 @@ typedef boost::multiprecision::number<
        boost::multiprecision::cpp_dec_float<24>,
        boost::multiprecision::et_off> Timestamp;
 
+/**
+ * Chooses a prefix so that the value in front of the decimal point is between 1 and 999.
+ */
+SIPrefix determine_value_prefix(double v);
+
 /**
  * Formats a given timestamp with the specified SI prefix.
  *
@@ -78,6 +89,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
@@ -112,9 +141,11 @@ QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
 QString format_time_minutes(const Timestamp& t, signed precision = 0,
        bool sign = true);
 
+vector<string> split_string(string text, string separator);
+
 } // namespace util
 } // namespace pv
 
 Q_DECLARE_METATYPE(pv::util::Timestamp)
 
-#endif // PULSEVIEW_UTIL_HPP
+#endif // PULSEVIEW_PV_UTIL_HPP