X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=pv%2Futil.hpp;h=fab29a14f05ac21ea90b88d37088c2f9274a278f;hb=5a5d3b1de81417f64b58e80cc359dcfde0d3a10c;hp=5be379035bd875ae4bf3e6636444b89a5903519a;hpb=3ccf0f7f5b1b31ac628a983a2becee6f4c4c1507;p=pulseview.git
diff --git a/pv/util.hpp b/pv/util.hpp
index 5be37903..fab29a14 100644
--- a/pv/util.hpp
+++ b/pv/util.hpp
@@ -14,24 +14,31 @@
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ * along with this program; if not, see .
*/
-#ifndef PULSEVIEW_UTIL_HPP
-#define PULSEVIEW_UTIL_HPP
+#ifndef PULSEVIEW_PV_UTIL_HPP
+#define PULSEVIEW_PV_UTIL_HPP
#include
+#include
+#include
+#ifndef Q_MOC_RUN
#include
+#endif
#include
#include
+using std::string;
+using std::vector;
+
namespace pv {
namespace util {
enum class TimeUnit {
+ None = 0,
Time = 1,
Samples = 2
};
@@ -55,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.
*
@@ -71,19 +83,34 @@ typedef boost::multiprecision::number<
* @param unit The unit of quantity.
* @param sign Whether or not to add a sign also for positive numbers.
*
- * @return The formated value.
+ * @return The formatted value.
*/
-QString format_time_si(
- const Timestamp& t,
- SIPrefix prefix = SIPrefix::unspecified,
- unsigned precision = 0,
- QString unit = "s",
- bool sign = true);
+QString format_time_si(const Timestamp& v,
+ SIPrefix prefix = SIPrefix::unspecified, unsigned precision = 0,
+ QString unit = "s", bool sign = true);
/**
- * Wrapper around 'format_time_si()' that interpretes the given 'precision'
+ * 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
- * without a SI prefix (using 'SIPrefix::none') and adjustes the precision to
+ * without a SI prefix (using 'SIPrefix::none') and adjusts the precision to
* match the given 'prefix'
*
* @param t The value to format.
@@ -93,14 +120,10 @@ QString format_time_si(
* @param unit The unit of quantity.
* @param sign Whether or not to add a sign also for positive numbers.
*
- * @return The formated value.
+ * @return The formatted value.
*/
-QString format_time_si_adjusted(
- const Timestamp& t,
- SIPrefix prefix,
- unsigned precision = 0,
- QString unit = "s",
- bool sign = true);
+QString format_time_si_adjusted(const Timestamp& t, SIPrefix prefix,
+ unsigned precision = 0, QString unit = "s", bool sign = true);
/**
* Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format.
@@ -113,16 +136,16 @@ QString format_time_si_adjusted(
* @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.
+ * @return The formatted value.
*/
-QString format_time_minutes(
- const Timestamp& t,
- signed precision = 0,
+QString format_time_minutes(const Timestamp& t, signed precision = 0,
bool sign = true);
+vector 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