Only show sampling points when zoomed in far enough.

[pulseview.git] / pv / util.hpp

diff --git a/pv/util.hpp b/pv/util.hpp
index ba6702f79f175f345ddfd814ae6fc1ae2ceeda78..1c78b89f1831b802f16531a90bed7a489905d92f 100644 (file)
--- a/pv/util.hpp
+++ b/pv/util.hpp
@@ -14,8 +14,7 @@
  * 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 <http://www.gnu.org/licenses/>.
  */
 
 #ifndef PULSEVIEW_UTIL_HPP
@@ -23,59 +22,108 @@
 
 #include <cmath>
 
+#ifndef Q_MOC_RUN
+#include <boost/multiprecision/cpp_dec_float.hpp>
+#endif
+
+#include <QMetaType>
 #include <QString>
 
 namespace pv {
 namespace util {
 
-enum TimeUnit {
+enum class TimeUnit {
        Time = 1,
        Samples = 2
 };
 
-extern const int FirstSIPrefixPower;
+enum class SIPrefix {
+       unspecified = -1,
+       yocto, zepto,
+       atto, femto, pico,
+       nano, micro, milli,
+       none,
+       kilo, mega, giga,
+       tera, peta, exa,
+       zetta, yotta
+};
+
+/// Returns the exponent that corresponds to a given prefix.
+int exponent(SIPrefix prefix);
+
+/// Timestamp type providing yoctosecond resolution.
+typedef boost::multiprecision::number<
+       boost::multiprecision::cpp_dec_float<24>,
+       boost::multiprecision::et_off> Timestamp;
 
 /**
- * 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.
+ * Formats a given timestamp with the specified SI prefix.
+ *
+ * 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.
+ *
+ * The default value "s" for the unit argument makes the most sense when
+ * formatting time values, but a different value can be given if the function
+ * is reused to format a value of another quantity.
+ *
+ * @param t 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 formated value.
+ * @return The formatted value.
  */
-QString format_si_value(
-       double v, QString unit, int prefix = -1,
-       unsigned precision = 0, bool sign = true);
+QString format_time_si(
+       const Timestamp& v,
+       SIPrefix prefix = SIPrefix::unspecified,
+       unsigned precision = 0,
+       QString unit = "s",
+       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'. If prefix is set to -1, the prefix will be calculated.
+ * 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 adjusts the precision to
+ * match the given 'prefix'
+ *
+ * @param t The value to format.
+ * @param prefix The SI prefix to use.
+ * @param precision The number of digits after the decimal separator if the
+ *        'prefix' would be 'SIPrefix::none', see above for more information.
  * @param unit The unit of quantity.
- * @param precision The number of digits after the decimal separator or period (.).
- * @param step_size The delta between two consecutive time markers (if applicable).
  * @param sign Whether or not to add a sign also for positive numbers.
  *
- * @return The formated value.
+ * @return The formatted value.
  */
-QString format_time(
-       double t, int prefix = -1, TimeUnit unit = Time, unsigned precision = 0,
-       double step_size = 0, bool sign = true);
+QString format_time_si_adjusted(
+       const Timestamp& t,
+       SIPrefix prefix,
+       unsigned precision = 0,
+       QString unit = "s",
+       bool sign = true);
 
 /**
- * Formats a given time value with a SI prefix so that the
- * value is between 1 and 999.
- * @param second The time value in seconds to format.
+ * Formats the given timestamp using "[+-]DD:HH:MM:SS.mmm uuu nnn ppp..." format.
  *
- * @return The formated value.
+ * "DD" and "HH" are left out if they would be "00" (but if "DD" is generated,
+ * "HH" is also always generated. The "MM:SS" part is always produced, the
+ * number of subsecond digits can be influenced using the 'precision' parameter.
+ *
+ * @param t The value to format.
+ * @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 formatted value.
  */
-QString format_second(double second);
+QString format_time_minutes(
+       const Timestamp& t,
+       signed precision = 0,
+       bool sign = true);
 
 } // namespace util
 } // namespace pv
 
+Q_DECLARE_METATYPE(pv::util::Timestamp)
+
 #endif // PULSEVIEW_UTIL_HPP