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 <iostream>
#include <memory>
 
#include <gz/math/config.hh>
#include "gz/math/Helpers.hh"
 
namespace ignition
{
  namespace math
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    //
    // Forward declare private data class.
    class TemperaturePrivate;
 
    class IGNITION_MATH_VISIBLE Temperature
    {
      public: Temperature();
 
      // cppcheck-suppress noExplicitConstructor
      public: Temperature(const double _temp);
 
      public: Temperature(const Temperature &_temp);
 
      public: virtual ~Temperature();
 
      public: static double KelvinToCelsius(const double _temp);
 
      public: static double KelvinToFahrenheit(const double _temp);
 
      public: static double CelsiusToFahrenheit(const double _temp);
 
      public: static double CelsiusToKelvin(const double _temp);
 
      public: static double FahrenheitToCelsius(const double _temp);
 
      public: static double FahrenheitToKelvin(const double _temp);
 
      public: void SetKelvin(const double _temp);
 
      public: void SetCelsius(const double _temp);
 
      public: void SetFahrenheit(const double _temp);
 
      public: double Kelvin() const;
 
      public: double Celsius() const;
 
      public: double Fahrenheit() const;
 
      public: double operator()() const;
 
      public: Temperature &operator=(const double _temp);
 
      public: Temperature &operator=(const Temperature &_temp);
 
      public: Temperature operator+(const double _temp) const;
 
      public: Temperature operator+(const Temperature &_temp) const;
 
      public: Temperature operator+(const double _temp);
 
      public: Temperature operator+(const Temperature &_temp);
 
      public: friend Temperature operator+(double _t, const Temperature &_temp)
      {
        return _t + _temp.Kelvin();
      }
 
      public: const Temperature &operator+=(const double _temp);
 
      public: const Temperature &operator+=(const Temperature &_temp);
 
      public: Temperature operator-(const double _temp);
 
      public: Temperature operator-(const Temperature &_temp);
 
      public: Temperature operator-(const 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-=(const double _temp);
 
      public: const Temperature &operator-=(const Temperature &_temp);
 
      public: Temperature operator*(const double _temp);
 
      public: Temperature operator*(const Temperature &_temp);
 
      public: Temperature operator*(const 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*=(const double _temp);
 
      public: const Temperature &operator*=(const Temperature &_temp);
 
      public: Temperature operator/(const double _temp);
 
      public: Temperature operator/(const Temperature &_temp);
 
      public: Temperature operator/(const 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/=(const double _temp);
 
      public: const Temperature &operator/=(const Temperature &_temp);
 
      public: bool operator==(const Temperature &_temp) const;
 
      public: bool operator==(const double _temp) const;
 
      public: bool operator!=(const Temperature &_temp) const;
 
      public: bool operator!=(const double _temp) const;
 
      public: bool operator<(const Temperature &_temp) const;
 
      public: bool operator<(const double _temp) const;
 
      public: bool operator<=(const Temperature &_temp) const;
 
      public: bool operator<=(const double _temp) const;
 
      public: bool operator>(const Temperature &_temp) const;
 
      public: bool operator>(const double _temp) const;
 
      public: bool operator>=(const Temperature &_temp) const;
 
      public: bool operator>=(const 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;
              }
 
#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<TemperaturePrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };
    }
  }
}
#endif