summaryrefslogtreecommitdiffstats
path: root/kalzium/src/tempunit.h
blob: 5c3e5e4e97ccc6ca7f4158eed5fce39615122e5e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
#ifndef TEMPUNIT_H
#define TEMPUNIT_H
/***************************************************************************
 *   Copyright (C) 2005 by Pino Toscano                                    *
 *   [email protected]                                               *
 *                                                                         *
 *   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 Street, Fifth Floor, Boston, MA  02110-1301, USA.          *
 ***************************************************************************/

#include <tqpair.h>
#include <tqstringlist.h>

/**
 * This class obtains all the info needed to work with the units of measure
 * of temperature.
 *
 * It has static methods you can call to get the various infos. The most
 * important methods is convert(), that performs conversions.
 *
 * @author Pino Toscano
 */
class TempUnit
{
	public:

		enum Unit { Kelvin = 0, 
			Celsius, 
			Fahrenheit,
			Rankine,
			Reaumur 
		};

		/**
		 * Convert the temperature unit @p value given in the unit
		 * @p from to the unit @p to.
		 *
		 * @return the value converted
		 */
		static double convert( double value,
		                       TempUnit::Unit from,
		                       TempUnit::Unit to );


		/**
		 * @param value the temperature to convert
		 * @param from the unit from which to convert
		 *
		 * @return the temperature to Kelvin
		 */
		static double convertToKelvin( const double value,
				TempUnit::Unit from );
		
		/**
		 * @overload
		 */
		static double convert( const double value,
		                       int from,
		                       int to );

		/**
		 * @return a list with the symbols of the temperature units
		 * we support
		 */
		static TQStringList unitListSymbols();

		/**
		 * @return the symbol of the @p i -th unit 
		 */
		static TQString unitListSymbol( int i );

		static TQPair<double, double> rangeForUnit( TempUnit::Unit u );

		/**
		 * @overload
		 */
		static TQPair<double, double> rangeForUnit( int u );

};
#endif // TEMPUNIT_H