gz/math/Temperature.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_MATH_TEMPERATURE_HH_
#define GZ_MATH_TEMPERATURE_HH_
 
#include <istream>
#include <ostream>
 
#include <gz/math/config.hh>
#include "gz/math/Helpers.hh"
#include <gz/utils/ImplPtr.hh>
 
 
namespace gz::math
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_MATH_VERSION_NAMESPACE {
  class GZ_MATH_VISIBLE Temperature
  {
    public: Temperature();
 
    // cppcheck-suppress noExplicitConstructor
    public: Temperature(double _temp);
 
    public: static double KelvinToCelsius(double _temp);
 
    public: static double KelvinToFahrenheit(double _temp);
 
    public: static double CelsiusToFahrenheit(double _temp);
 
    public: static double CelsiusToKelvin(double _temp);
 
    public: static double FahrenheitToCelsius(double _temp);
 
    public: static double FahrenheitToKelvin(double _temp);
 
    public: void SetKelvin(double _temp);
 
    public: void SetCelsius(double _temp);
 
    public: void SetFahrenheit(double _temp);
 
    public: double Kelvin() const;
 
    public: double Celsius() const;
 
    public: double Fahrenheit() const;
 
    public: double operator()() const;
 
    public: Temperature &operator=(double _temp);
 
    public: Temperature operator+(double _temp) const;
 
    public: Temperature operator+(const Temperature &_temp) const;
 
    public: friend Temperature operator+(double _t, const Temperature &_temp)
    {
      return _t + _temp.Kelvin();
    }
 
    public: const Temperature &operator+=(double _temp);
 
    public: const Temperature &operator+=(const Temperature &_temp);
 
    public: Temperature operator-(double _temp) const;
 
    public: Temperature operator-(const Temperature &_temp) const;
 
    public: friend Temperature operator-(double _t, const Temperature &_temp)
    {
      return _t - _temp.Kelvin();
    }
 
    public: const Temperature &operator-=(double _temp);
 
    public: const Temperature &operator-=(const Temperature &_temp);
 
    public: Temperature operator*(double _temp) const;
 
    public: Temperature operator*(const Temperature &_temp) const;
 
    public: friend Temperature operator*(double _t, const Temperature &_temp)
    {
      return _t * _temp.Kelvin();
    }
 
    public: const Temperature &operator*=(double _temp);
 
    public: const Temperature &operator*=(const Temperature &_temp);
 
    public: Temperature operator/(double _temp) const;
 
    public: Temperature operator/(const Temperature &_temp) const;
 
    public: friend Temperature operator/(double _t, const Temperature &_temp)
    {
      return _t / _temp.Kelvin();
    }
 
    public: const Temperature &operator/=(double _temp);
 
    public: const Temperature &operator/=(const Temperature &_temp);
 
    public: bool operator==(const Temperature &_temp) const;
 
    public: bool operator==(double _temp) const;
 
    public: bool operator!=(const Temperature &_temp) const;
 
    public: bool operator!=(double _temp) const;
 
    public: bool operator<(const Temperature &_temp) const;
 
    public: bool operator<(double _temp) const;
 
    public: bool operator<=(const Temperature &_temp) const;
 
    public: bool operator<=(double _temp) const;
 
    public: bool operator>(const Temperature &_temp) const;
 
    public: bool operator>(double _temp) const;
 
    public: bool operator>=(const Temperature &_temp) const;
 
    public: bool operator>=(double _temp) const;
 
    public: friend std::ostream &operator<<(std::ostream &_out,
                const gz::math::Temperature &_temp)
            {
              _out << _temp.Kelvin();
              return _out;
            }
 
    public: friend std::istream &operator>>(std::istream &_in,
                gz::math::Temperature &_temp)
            {
              // Skip white spaces
              _in.setf(std::ios_base::skipws);
 
              double kelvin;
              _in >> kelvin;
 
              if (!_in.fail())
              {
                _temp.SetKelvin(kelvin);
              }
              return _in;
            }
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
  }  // namespace GZ_MATH_VERSION_NAMESPACE
}  // namespace gz::math
#endif  // GZ_MATH_TEMPERATURE_HH_