Displacement.h

Go to the documentation of this file.

#ifndef Displacement_h
#define Displacement_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
namespace Isis {
  class Distance;
 
  class Displacement {
    public:
      enum Units {
        Meters,
        Kilometers,
        Pixels
      };
 
      Displacement();
      Displacement(double displacement, Units distanceUnit);
      Displacement(double displacementInPixels, double pixelsPerMeter);
      Displacement(const Distance &distanceToCopy);
 
      ~Displacement() {};
 
      double meters() const;
      void setMeters(double displacementInMeters);
 
      double kilometers() const;
      void setKilometers(double displacementInKilometers);
 
      double pixels(double pixelsPerMeter = 1.0) const;
      void setPixels(double distanceInPixels, double pixelsPerMeter = 1.0);
 
      bool isValid() const;
 
      bool operator >(const Displacement &otherDisplacement) const;
      bool operator <(const Displacement &otherDisplacement) const;
 
 
      bool operator >=(const Displacement &otherDisplacement) const {
        return *this > otherDisplacement  ||  *this == otherDisplacement;
      }
 
 
      bool operator <=(const Displacement &otherDisplacement) const {
        return *this < otherDisplacement  ||  *this == otherDisplacement;
      }
 
      bool operator !=(const Displacement &otherDisplacement) const {
        return !(*this == otherDisplacement);
      }
 
      bool operator ==(const Displacement &otherDisplacement) const {
        return m_displacementInMeters ==
               otherDisplacement.m_displacementInMeters;
      }
 
      Displacement operator +(const Displacement &displacementToAdd) const;
      Displacement operator -(const Displacement &displacementToSub) const;
      Displacement operator -(const Distance &distanceToSub) const;
      double operator /(const Displacement &displacementToDiv) const;
      Displacement operator /(const double &valueToDiv) const;
      Displacement operator *(const double &valueToMult) const;
      friend Displacement operator *(double mult, Displacement displacement);
      void operator +=(const Displacement &displacementToAdd);
      void operator -=(const Displacement &displacementToSub);
      void operator -=(const Distance &distanceToSub);
      void operator /=(const double &valueToDiv);
      void operator *=(const double &valueToMult);
 
    protected:
      double displacement(Units displacementUnit) const;
      void setDisplacement(const double &displacement, Units displacementUnit);
 
    private:
      double m_displacementInMeters;
  };
}
 
#endif