Angle.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 3.0 of the License, or
//  any later version.
//
//  The GNSSTk 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
#ifndef GNSSTK_ANGLE_HPP
#define GNSSTK_ANGLE_HPP
 
#include "AngleReduced.hpp"
 
namespace gnsstk
{
 
 
   class Angle : public AngleReduced
   {
   public:
      Angle();
 
      explicit Angle(double s, double c);
 
      explicit Angle(double v, AngleType t)
      { setValue(v, t); }
 
      void setValue(double v, AngleType t);
 
      Angle operator-(const Angle& right) const;
 
      Angle operator-() const
      { return Angle(-radians, AngleType::Rad); }
 
      Angle operator+(const Angle& right) const;
 
      inline double rad() const
      { return radians; }
 
      inline double deg() const
      { return degrees; }
 
      inline double semicirc() const
      { return semicircles; }
 
      inline double tan() const
      { return tangent; }
 
      std::string asString() const;
 
   protected:
      double radians; 
      double degrees; 
      double tangent; 
      double semicircles; 
 
   private:
         // Disable a bunch of constructors so unexpected behavior is
         // avoided in C++.  In python, all bets are off,
         // unfortunately.
      explicit Angle(int, int);
      explicit Angle(long, long);
      explicit Angle(unsigned, unsigned);
      explicit Angle(unsigned long, unsigned long);
   }; // class Angle
 
 
   inline std::ostream& operator<<(std::ostream& s, const Angle& a)
   {
      s << std::setprecision(20) << "rad:" << a.rad() << ",deg:" << a.deg()
        << ",semi-circles:" << a.semicirc() << ",sin:" << a.sin() << ",cos:"
        << a.cos() << ",tan:" << a.tan();
      return s;
   }
 
 
} // namespace gnsstk
 
namespace std
{
   inline double sin(gnsstk::Angle x)
   { return x.sin(); }
   inline double cos(gnsstk::Angle x)
   { return x.cos(); }
   inline double tan(gnsstk::Angle x)
   { return x.tan(); }
}
 
#endif // GNSSTK_ANGLE_HPP