Distance.h

Go to the documentation of this file.

#ifndef Distance_h
#define Distance_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
class QString;
 
namespace Isis {
  class Displacement;
 
  class Distance {
    public:
      enum Units {
        Meters,
        Kilometers,
        Pixels,
        SolarRadii
      };
 
      Distance();
      Distance(double distance, Units distanceUnit);
      Distance(double distanceInPixels, double pixelsPerMeter);
      Distance(const Distance &distanceToCopy);
      virtual ~Distance();
 
      double meters() const;
      void setMeters(double distanceInMeters);
 
      double kilometers() const;
      void setKilometers(double distanceInKilometers);
 
      double pixels(double pixelsPerMeter = 1.0) const;
      void setPixels(double distanceInPixels, double pixelsPerMeter = 1.0);
 
      double solarRadii() const;
      void setSolarRadii(double distanceInSolarRadii);
 
      QString toString() const;
      bool isValid() const;
 
      bool operator >(const Distance &otherDistance) const;
      bool operator <(const Distance &otherDistance) const;
 
      bool operator >=(const Distance &otherDistance) const {
        return *this > otherDistance || *this == otherDistance;
      }
 
 
      bool operator <=(const Distance &otherDistance) const {
        return *this < otherDistance || *this == otherDistance;
      }
 
 
      bool operator ==(const Distance &otherDistance) const {
        return meters() == otherDistance.meters();
      }
 
 
      bool operator !=(const Distance &otherDistance) const {
        return meters() != otherDistance.meters();
      }
 
 
      Distance &operator =(const Distance &distanceToCopy);
      Distance operator +(const Distance &distanceToAdd) const;
      Displacement operator -(const Distance &distanceToSub) const;
      double operator /(const Distance &distanceToDiv) const;
      Distance operator /(const double &valueToDiv) const;
      Distance operator *(const double &valueToMult) const;
      friend Distance operator *(double mult, Distance dist);
      void operator +=(const Distance &distanceToAdd);
      void operator -=(const Distance &distanceToSub);
      void operator /=(const double &valueToDiv);
      void operator *=(const double &valueToMult);
 
    protected:
      virtual double distance(Units distanceUnit) const;
      virtual void setDistance(const double &distance, Units distanceUnit);
 
    private:
      double m_distanceInMeters;
  };
}
 
#endif