Latitude.h

Go to the documentation of this file.

#ifndef Latitude_h
#define Latitude_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include "Angle.h"
 
namespace Isis {
  class Distance;
  class PvlGroup;
 
  class Latitude : public Angle {
    public:
      enum ErrorChecking {
        ThrowAllErrors = 0,
        AllowPastPole
      };
 
      enum CoordinateType {
        Planetocentric,
        Planetographic
      };
 
      Latitude();
      Latitude(double latitude,
               Angle::Units latitudeUnits,
               ErrorChecking errors = AllowPastPole);
 
      Latitude(Angle latitude, ErrorChecking errors = AllowPastPole);
 
      Latitude(Angle latitude,
               PvlGroup mapping,
               ErrorChecking errors = ThrowAllErrors);
 
      Latitude(double latitude,
               PvlGroup mapping,
               Angle::Units latitudeUnits,
               ErrorChecking errors = ThrowAllErrors);
 
      Latitude(double latitude, Distance equatorialRadius, Distance polarRadius,
               CoordinateType latType = Planetocentric,
               Angle::Units latitudeUnits = Angle::Radians,
               ErrorChecking errors = ThrowAllErrors);
 
      Latitude(const Latitude &latitudeToCopy);
 
      ~Latitude();
 
      double planetocentric(Angle::Units units = Angle::Radians) const;
      void setPlanetocentric(double latitude,
                             Angle::Units units = Angle::Radians);
 
      double planetographic(Angle::Units units = Angle::Radians) const;
      void setPlanetographic(double latitude,
                           Angle::Units units = Angle::Radians);
 
      ErrorChecking errorChecking() const;
      void setErrorChecking(ErrorChecking errors);
 
      bool inRange(Latitude min, Latitude max) const;
 
      Latitude& operator=(const Latitude & latitudeToCopy);
      Latitude add(Angle angleToAdd, PvlGroup mapping);
      Latitude add(Angle angleToAdd, Distance equatorialRadius, Distance polarRadius,
                   CoordinateType latType);
 
    protected:
      virtual void setAngle(const double &angle, const Angle::Units &units);
 
    private:
      Distance *m_equatorialRadius;
      Distance *m_polarRadius;
 
      ErrorChecking m_errors;
  };
}
 
#endif