[pulseview.git] / pv / util.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * 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
 */

#ifndef PULSEVIEW_UTIL_H
#define PULSEVIEW_UTIL_H

#include <math.h>

#include <QString>

namespace pv {
namespace util {

extern const int FirstSIPrefixPower;

/**
 * Formats a given time value 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.
 * @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);

/**
 * 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.
 *
 * @return The formated value.
 */
QString format_second(double second);

} // namespace util
} // namespace pv

#endif // PULSEVIEW_UTIL_H
Commit	Line	Data
f0c9f81c JS	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#ifndef PULSEVIEW_UTIL_H
	22	#define PULSEVIEW_UTIL_H
	23
	24	#include <math.h>
	25
	26	#include <QString>
	27
	28	namespace pv {
	29	namespace util {
	30
	31	extern const int FirstSIPrefixPower;
	32
	33	/**
	34	* Formats a given time value with the specified SI prefix.
	35	* @param t The time value in seconds to format.
	36	* @param prefix The number of the prefix, from 0 for 'femto' up to
	37	* 8 for 'giga'.
	38	* @parma precision The number of digits after the decimal separator.
	39	* @param sign Whether or not to add a sign also for positive numbers.
	40	*
	41	* @return The formated value.
	42	*/
	43	QString format_time(
	44	double t, unsigned int prefix,
	45	unsigned precision = 0, bool sign = true);
	46
62974f45 JS	47	/**
	48	* Formats a given time value with a SI prefix so that the
	49	* value is between 1 and 999.
	50	* @param second The time value in seconds to format.
	51	*
	52	* @return The formated value.
	53	*/
	54	QString format_second(double second);
	55
f0c9f81c JS	56	} // namespace util
	57	} // namespace pv
	58
	59	#endif // PULSEVIEW_UTIL_H