Angle.h

Go to the documentation of this file.

// $Id: Angle.h,v 1.26 2007/07/06 14:26:39 abeard Exp $

#ifndef CARMA_SERVICES_ANGLE_H
#define CARMA_SERVICES_ANGLE_H

#include "carma/services/ConformableQuantity.h"
#include <string>
#include <cmath>

namespace carma  {
  namespace services {
    class Angle : public ConformableQuantity {
    public:

      explicit Angle( );

      explicit Angle(double value, const std::string& units);

      virtual ~Angle();
      
      double radians(bool modulo = true) const;
      
      double hours(bool modulo = true) const;
      
      double degrees(bool modulo = false) const;
      
      double arcMinutes(bool modulo = false) const;
      
      double arcSeconds(bool modulo = false) const;
      
      std::string dms(bool modulo = true, int precision = 0) const;

      inline void setRadians(double radians) 
      {
        reset(radians,"radians");
      }
      const Angle operator+(const Angle& angle) const;
      
      const Angle operator-(const Angle& angle) const;
      
      friend const Angle operator*(double left, const Angle & right );
      friend const Angle operator*(const Angle & left, double right );

      const Angle operator/(double scalar) const;

      Angle& operator+=(const Angle& angle);
      
      Angle& operator-=(const Angle& angle);

      Angle & operator*=(double scalar);

      Angle & operator/=(double scalar);
      
      bool operator<( const Angle & right ) const;
      
      bool operator>( const Angle & right ) const;

      bool operator<=( const Angle & right ) const;

      bool operator>=( const Angle & right ) const;

      static inline std::string getString(double angle, int precision=0) 
      {
        return getAngleString(angle, precision, true, true);
      }

    protected:
      static const double twoPi_     = 2 * M_PIl;
      
      /*
       * helper for Angle and HourAngle
       * @return (+/-) hh:mm:ss or dd:mm:ss, value will be leading zero-filled.
       * @param angle in radians
       * @param precision    number of digits after the decimal point
       * @param dms  true of dms, false is hms
       * @param use the leading sign if positive
       *
       */
      static std::string getAngleString(double a, 
                                        int precision=0, 
                                        bool dms=true, 
                                        bool useSign = false);
      
    public:

      static const std::string RADIANS_STR;

      static const std::string DEGREES_STR;

      static const std::string HOURS_STR;

      static const std::string ARCMIN_STR;

      static const std::string ARCSEC_STR;

    private:
      
      const Angle moduloTwoPi(double value) const;
      
      double moduloTwoPiDouble(double value) const;

    };

    std::ostream& operator<<(std::ostream& os, 
                             const carma::services::Angle& angle);
    
      
    const Angle operator*(double left, const Angle & right );
    const Angle operator*(const Angle & left, double right );
  }
}


#endif //CARMA_SERVICES_ANGLE_H