gem5  v21.1.0.2
temperature.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021 Arm Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef __BASE_TEMPERATURE_HH__
39 #define __BASE_TEMPERATURE_HH__
40 
41 #include <ostream>
42 
43 namespace gem5
44 {
45 
51 {
52 
53  private:
55  double value;
56 
57  public:
59  explicit constexpr Temperature(double _value=0.0)
60  : value(_value)
61  {
62  }
63 
64  static Temperature fromKelvin(double _value);
65  static Temperature fromCelsius(double _value);
66  static Temperature fromFahrenheit(double _value);
67 
68  constexpr double toKelvin() const { return value; }
69  constexpr double toCelsius() const { return value - 273.15; }
70  double toFahrenheit() const;
71 
72  constexpr bool
73  operator>(const Temperature &rhs) const
74  {
75  return value > rhs.value;
76  }
77 
78  constexpr bool
79  operator>=(const Temperature &rhs) const
80  {
81  return value >= rhs.value;
82  }
83 
84  constexpr bool
85  operator<(const Temperature &rhs) const
86  {
87  return value < rhs.value;
88  }
89 
90  constexpr bool
91  operator<=(const Temperature &rhs) const
92  {
93  return value <= rhs.value;
94  }
95 
96  constexpr bool
97  operator==(const Temperature &rhs) const
98  {
99  return value == rhs.value;
100  }
101 
102  constexpr bool
103  operator!=(const Temperature &rhs) const
104  {
105  return value != rhs.value;
106  }
107 
108  constexpr Temperature
109  operator+(const Temperature &rhs) const
110  {
111  return Temperature(value + rhs.value);
112  }
113 
114  constexpr Temperature
115  operator-(const Temperature &rhs) const
116  {
117  return Temperature(value - rhs.value);
118  }
119 
120  friend constexpr Temperature operator*(
121  const Temperature &lhs, const double &rhs);
122 
123  friend constexpr Temperature operator*(
124  const double &lhs, const Temperature &rhs);
125 
126  friend constexpr Temperature operator/(
127  const Temperature &lhs, const double &rhs);
128 
129  Temperature &
131  {
132  value += rhs.value;
133  return *this;
134  }
135 
136  Temperature &
138  {
139  value -= rhs.value;
140  return *this;
141  }
142 
143  Temperature &
144  operator*=(const double &rhs)
145  {
146  value *= rhs;
147  return *this;
148  }
149 
150  Temperature &
151  operator/=(const double &rhs)
152  {
153  value /= rhs;
154  return *this;
155  }
156 
157  friend std::ostream &operator<<(std::ostream &out, const Temperature &t);
158 };
159 
160 constexpr Temperature
161 operator*(const Temperature &lhs, const double &rhs)
162 {
163  return Temperature(lhs.value * rhs);
164 }
165 
166 constexpr Temperature
167 operator*(const double &lhs, const Temperature &rhs)
168 {
169  return Temperature(lhs * rhs.value);
170 }
171 
172 constexpr Temperature
173 operator/(const Temperature &lhs, const double &rhs)
174 {
175  return Temperature(lhs.value / rhs);
176 }
177 
178 } // namespace gem5
179 
180 #endif // __BASE_TEMPERATURE_HH__
gem5::Temperature::toCelsius
constexpr double toCelsius() const
Definition: temperature.hh:69
gem5::Temperature::value
double value
Temperature in Kelvin.
Definition: temperature.hh:55
gem5::Temperature::operator>=
constexpr bool operator>=(const Temperature &rhs) const
Definition: temperature.hh:79
gem5::Temperature::operator==
constexpr bool operator==(const Temperature &rhs) const
Definition: temperature.hh:97
gem5::Temperature::operator-
constexpr Temperature operator-(const Temperature &rhs) const
Definition: temperature.hh:115
gem5::operator*
constexpr Temperature operator*(const Temperature &lhs, const double &rhs)
Definition: temperature.hh:161
gem5::Temperature::operator<
constexpr bool operator<(const Temperature &rhs) const
Definition: temperature.hh:85
gem5::Temperature::operator!=
constexpr bool operator!=(const Temperature &rhs) const
Definition: temperature.hh:103
gem5::Temperature::operator/
constexpr friend Temperature operator/(const Temperature &lhs, const double &rhs)
Definition: temperature.hh:173
gem5::Temperature::operator-=
Temperature & operator-=(const Temperature &rhs)
Definition: temperature.hh:137
gem5::Temperature::operator*
constexpr friend Temperature operator*(const Temperature &lhs, const double &rhs)
Definition: temperature.hh:161
gem5::Temperature
The class stores temperatures in Kelvin and provides helper methods to convert to/from Celsius.
Definition: temperature.hh:50
gem5::Temperature::operator+
constexpr Temperature operator+(const Temperature &rhs) const
Definition: temperature.hh:109
gem5::Temperature::fromKelvin
static Temperature fromKelvin(double _value)
Definition: temperature.cc:44
gem5::Temperature::fromFahrenheit
static Temperature fromFahrenheit(double _value)
Definition: temperature.cc:56
gem5::Temperature::operator<=
constexpr bool operator<=(const Temperature &rhs) const
Definition: temperature.hh:91
gem5::Temperature::operator*=
Temperature & operator*=(const double &rhs)
Definition: temperature.hh:144
gem5::ArmISA::t
Bitfield< 5 > t
Definition: misc_types.hh:70
gem5::Temperature::toKelvin
constexpr double toKelvin() const
Definition: temperature.hh:68
gem5::Temperature::operator/=
Temperature & operator/=(const double &rhs)
Definition: temperature.hh:151
gem5::Temperature::operator<<
friend std::ostream & operator<<(std::ostream &out, const Temperature &t)
Definition: temperature.cc:68
gem5::Temperature::fromCelsius
static Temperature fromCelsius(double _value)
Definition: temperature.cc:50
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::Temperature::toFahrenheit
double toFahrenheit() const
Definition: temperature.cc:62
gem5::operator/
constexpr Temperature operator/(const Temperature &lhs, const double &rhs)
Definition: temperature.hh:173
gem5::Temperature::operator>
constexpr bool operator>(const Temperature &rhs) const
Definition: temperature.hh:73
gem5::Temperature::operator+=
Temperature & operator+=(const Temperature &rhs)
Definition: temperature.hh:130
gem5::Temperature::Temperature
constexpr Temperature(double _value=0.0)
Explicit constructor assigning a value.
Definition: temperature.hh:59

Generated on Tue Sep 21 2021 12:25:00 for gem5 by doxygen 1.8.17