GyotoConverters.h

Go to the documentation of this file.

/*
    Copyright 2011-2016 Thibaut Paumard

    This file is part of Gyoto.

    Gyoto 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 3 of the License, or
    (at your option) any later version.

    Gyoto 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 Gyoto.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GyotoConverters_H_ 
#define __GyotoConverters_H_ 

#include <GyotoUtils.h>
#include <GyotoSmartPointer.h>

#ifdef HAVE_UDUNITS
#include <udunits2.h>
#endif

#include <string>
#include <sstream>

namespace Gyoto {
  namespace Metric {
    class Generic;
  }
  namespace Units {
#ifdef HAVE_UDUNITS

    class Unit;

    class Converter;

    ut_system * getSystem();
#endif

    void Init();

    double ToMeters(double value, const std::string &unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> &gg=NULL);

    double FromMeters(double value, const std::string &unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> &gg=NULL);

    double ToSeconds(double value, const std::string &unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> &gg=NULL);

    double FromSeconds(double value, const std::string &unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> &gg=NULL);

    double ToKilograms(double value, const std::string & unit);

    double FromKilograms(double value, const std::string & unit);

    double ToGeometrical(double value, const std::string & unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> & gg);

    double FromGeometrical(double value, const std::string & unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> & gg);

    double ToGeometricalTime(double value, const std::string & unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> & gg);

    double FromGeometricalTime(double value, const std::string & unit,
                  const Gyoto::SmartPointer<Gyoto::Metric::Generic> &gg);


    double ToHerz(double value, const std::string &unit);

    double FromHerz(double value, const std::string &unit);

#   ifdef HAVE_UDUNITS

    bool areConvertible(const Unit &unit1, const Unit &unit2);
#   endif
  }
}

#ifdef HAVE_UDUNITS
class Gyoto::Units::Unit : public Gyoto::SmartPointee {
  friend class Gyoto::SmartPointer<Gyoto::Units::Unit>;
  friend class Gyoto::Units::Converter;
 private:
  ut_unit * unit_; 
  std::string kind_; 
 public:

  Unit(const std::string &unit);

  Unit(char const * const unit);

  ~Unit();

  double To (double val, const Unit &from_unit);

  double From (double val, const Unit &to_unit);

  operator std::string() const ;

  operator ut_unit*() const ;
};

class Gyoto::Units::Converter : public Gyoto::SmartPointee {
  friend class Gyoto::SmartPointer<Gyoto::Units::Converter>;
 private:
  cv_converter * converter_; 

 public:
  Converter(); 
  Converter(const Gyoto::Units::Unit& from,
            const Gyoto::Units::Unit& to);
  ~Converter();

  void reset(); 
  void reset(const Gyoto::Units::Unit& from,
        const Gyoto::Units::Unit& to);

  double operator()(double value) const ;
};

#endif

#endif