ome-common 5.3.2

temperature.h
Go to the documentation of this file.
1 /*
2 * #%L
3 * OME-COMMON C++ library for C++ compatibility/portability
4 * %%
5 * Copyright © 2015 Open Microscopy Environment:
6 * - Massachusetts Institute of Technology
7 * - National Institutes of Health
8 * - University of Dundee
9 * - Board of Regents of the University of Wisconsin-Madison
10 * - Glencoe Software, Inc.
11 * %%
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright notice,
16 * this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
18 * this list of conditions and the following disclaimer in the documentation
19 * and/or other materials provided with the distribution.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * The views and conclusions contained in the software and documentation are
34 * those of the authors and should not be interpreted as representing official
35 * policies, either expressed or implied, of any organization.
36 * #L%
37 */
38
47 #ifndef OME_COMMON_UNITS_TEMPERATURE_H
48 #define OME_COMMON_UNITS_TEMPERATURE_H
49
50 #include <ome/common/config.h>
51 #include <ome/common/units/types.h>
52
53 #include <boost/units/base_units/si/kelvin.hpp>
54 #include <boost/units/base_units/temperature/celsius.hpp>
55 #include <boost/units/base_units/temperature/fahrenheit.hpp>
56 #include <boost/units/unit.hpp>
57 #include <boost/units/quantity.hpp>
58 #include <boost/units/systems/si.hpp>
59
60 namespace ome
61 {
62 namespace common
63 {
64 namespace units
65 {
66
67 // Temperature types, constants and quantities.
68
70 typedef si::temperature temperature_unit;
72 typedef quantity<si::temperature> temperature_quantity;
73
75 typedef boost::units::si::kelvin_base_unit::unit_type kelvin_unit;
77 BOOST_UNITS_STATIC_CONSTANT(kelvin, kelvin_unit);
79 BOOST_UNITS_STATIC_CONSTANT(kelvins, kelvin_unit);
81 typedef quantity<kelvin_unit> kelvin_quantity;
82
84 typedef boost::units::temperature::celsius_base_unit::unit_type celsius_unit;
86 BOOST_UNITS_STATIC_CONSTANT(celsius, celsius_unit);
88 typedef quantity<celsius_unit> celsius_quantity;
89
91 typedef boost::units::temperature::fahrenheit_base_unit::unit_type fahrenheit_unit;
93 BOOST_UNITS_STATIC_CONSTANT(fahrenheit, fahrenheit_unit);
95 typedef quantity<fahrenheit_unit> fahrenheit_quantity;
96
98 struct rankine_base_unit : boost::units::base_unit<rankine_base_unit,
99 boost::units::temperature_dimension, 4> { };
101 typedef rankine_base_unit::unit_type rankine_unit;
103 BOOST_UNITS_STATIC_CONSTANT(rankine, rankine_unit);
105 typedef quantity<rankine_unit> rankine_quantity;
106
108 typedef boost::units::absolute<kelvin_unit> kelvin_absolute_unit;
110 BOOST_UNITS_STATIC_CONSTANT(kelvin_absolute, kelvin_absolute_unit);
112 BOOST_UNITS_STATIC_CONSTANT(kelvins_absolute, kelvin_absolute_unit);
114 typedef quantity<kelvin_absolute_unit> kelvin_absolute_quantity;
115
117 typedef boost::units::absolute<celsius_unit> celsius_absolute_unit;
119 BOOST_UNITS_STATIC_CONSTANT(celsius_absolute, celsius_absolute_unit);
121 typedef quantity<celsius_absolute_unit> celsius_absolute_quantity;
122
124 typedef boost::units::absolute<fahrenheit_unit> fahrenheit_absolute_unit;
126 BOOST_UNITS_STATIC_CONSTANT(fahrenheit_absolute, fahrenheit_absolute_unit);
128 typedef quantity<fahrenheit_absolute_unit> fahrenheit_absolute_quantity;
129
131 typedef boost::units::absolute<rankine_unit> rankine_absolute_unit;
133 BOOST_UNITS_STATIC_CONSTANT(rankine_absolute, rankine_absolute_unit);
135 typedef quantity<rankine_absolute_unit> rankine_absolute_quantity;
136
137 }
138 }
139 }
140
142 BOOST_UNITS_DEFINE_CONVERSION_FACTOR(ome::common::units::rankine_base_unit, boost::units::si::kelvin_base_unit, double, 5.0 / 9.0); // exact conversion
144 BOOST_UNITS_DEFINE_CONVERSION_OFFSET(ome::common::units::rankine_base_unit, boost::units::si::kelvin_base_unit, double, 0.0);
146 BOOST_UNITS_DEFINE_CONVERSION_FACTOR(ome::common::units::rankine_base_unit, boost::units::temperature::celsius_base_unit, double, 5.0 / 9.0); // exact conversion
148 BOOST_UNITS_DEFINE_CONVERSION_OFFSET(ome::common::units::rankine_base_unit, boost::units::temperature::celsius_base_unit, double, -273.15);
150 BOOST_UNITS_DEFINE_CONVERSION_FACTOR(ome::common::units::rankine_base_unit, boost::units::temperature::fahrenheit_base_unit, one, make_one()); // exact conversion
152 BOOST_UNITS_DEFINE_CONVERSION_OFFSET(ome::common::units::rankine_base_unit, boost::units::temperature::fahrenheit_base_unit, double, -459.67);
154 BOOST_UNITS_DEFAULT_CONVERSION(ome::common::units::rankine_base_unit, boost::units::si::kelvin_base_unit);
155
156 namespace boost
157 {
158 namespace units
159 {
160
162 template<> struct base_unit_info<ome::common::units::rankine_base_unit>
163 {
165 static std::string name() { return "rankine"; }
167 static std::string symbol() { return "R"; }
168 };
169
170 }
171 }
172
173 #endif // OME_COMMON_UNITS_TEMPERATURE_H
174
175 /*
176 * Local Variables:
177 * mode:C++
178 * End:
179 */
ome::common::units::BOOST_UNITS_STATIC_CONSTANT
BOOST_UNITS_STATIC_CONSTANT(radian, radian_unit)
Numeric constant for radian.
ome::common::units::fahrenheit_absolute_unit
boost::units::absolute< fahrenheit_unit > fahrenheit_absolute_unit
Unit definition for absolute temperature in Fahrenheit.
Definition: temperature.h:124
ome::common::units::kelvin_absolute_quantity
quantity< kelvin_absolute_unit > kelvin_absolute_quantity
Measured quantity in absolute kelvin.
Definition: temperature.h:114
ome::common::units::temperature_unit
si::temperature temperature_unit
Unit definition for temperature.
Definition: temperature.h:70
boost
Definition: length.h:576
ome::common::units::temperature_quantity
quantity< si::temperature > temperature_quantity
Measured quantity in temperature.
Definition: temperature.h:72
boost::units::base_unit_info< ome::common::units::rankine_base_unit >::symbol
static std::string symbol()
Unit symbol.
Definition: temperature.h:167
ome::common::units::fahrenheit_absolute_quantity
quantity< fahrenheit_absolute_unit > fahrenheit_absolute_quantity
Measured quantity in absolute Fahrenheit.
Definition: temperature.h:128
ome::common::units::fahrenheit_quantity
quantity< fahrenheit_unit > fahrenheit_quantity
Measured quantity in Fahrenheit.
Definition: temperature.h:95
ome::common::units::rankine_unit
rankine_base_unit::unit_type rankine_unit
Unit definition for relative temperature in Rankine.
Definition: temperature.h:101
ome::common::units::rankine_base_unit
Base unit for temperature in Rankine.
Definition: temperature.h:98
ome::common::units::kelvin_quantity
quantity< kelvin_unit > kelvin_quantity
Measured quantity in kelvin.
Definition: temperature.h:81
ome::common::units::celsius_quantity
quantity< celsius_unit > celsius_quantity
Measured quantity in Celsius.
Definition: temperature.h:88
ome::common::units::rankine_quantity
quantity< rankine_unit > rankine_quantity
Measured quantity in Rankine.
Definition: temperature.h:105
ome
Open Microscopy Environment C++.
Definition: base64.h:49
ome::common::units::kelvin_unit
boost::units::si::kelvin_base_unit::unit_type kelvin_unit
Unit definition for relative temperature in kelvin.
Definition: temperature.h:75
ome::common::units::celsius_absolute_unit
boost::units::absolute< celsius_unit > celsius_absolute_unit
Unit definition for absolute temperature in Celsius.
Definition: temperature.h:117
ome::common::units::fahrenheit_unit
boost::units::temperature::fahrenheit_base_unit::unit_type fahrenheit_unit
Unit definition for relative temperature in Fahrenheit (not convertible to or from other units due to...
Definition: temperature.h:91
ome::common::units::rankine_absolute_quantity
quantity< rankine_absolute_unit > rankine_absolute_quantity
Measured quantity in absolute Rankine.
Definition: temperature.h:135
ome::common::units::kelvin_absolute_unit
boost::units::absolute< kelvin_unit > kelvin_absolute_unit
Unit definition for absolute temperature in kelvin.
Definition: temperature.h:108
ome::common::units::rankine_absolute_unit
boost::units::absolute< rankine_unit > rankine_absolute_unit
Unit definition for absolute temperature in Rankine.
Definition: temperature.h:131
BOOST_UNITS_DEFINE_CONVERSION_OFFSET
BOOST_UNITS_DEFINE_CONVERSION_OFFSET(ome::common::units::rankine_base_unit, boost::units::si::kelvin_base_unit, double, 0.0)
Conversion offset for Rankine to kelvin.
ome::common::units::celsius_unit
boost::units::temperature::celsius_base_unit::unit_type celsius_unit
Unit definition for relative temperature in Celsius (not convertible to or from other units due to re...
Definition: temperature.h:84
BOOST_UNITS_DEFINE_CONVERSION_FACTOR
BOOST_UNITS_DEFINE_CONVERSION_FACTOR(ome::common::units::rankine_base_unit, boost::units::si::kelvin_base_unit, double, 5.0/9.0)
Conversion factor for Rankine to kelvin.
BOOST_UNITS_DEFAULT_CONVERSION
BOOST_UNITS_DEFAULT_CONVERSION(ome::common::units::rankine_base_unit, boost::units::si::kelvin_base_unit)
Default conversion for Rankine is to SI temperature units (kelvin).
boost::units::base_unit_info< ome::common::units::rankine_base_unit >::name
static std::string name()
Unit name.
Definition: temperature.h:165
ome::common::units::celsius_absolute_quantity
quantity< celsius_absolute_unit > celsius_absolute_quantity
Measured quantity in absolute Celsius.
Definition: temperature.h:121