GeoCoord.h

Go to the documentation of this file.

#ifndef OSMSCOUT_GEOCOORD_H
#define OSMSCOUT_GEOCOORD_H
 
/*
  This source is part of the libosmscout library
  Copyright (C) 2013  Tim Teulings
 
  This library 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 2.1 of the License, or (at your option) any later version.
 
  This library 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 this library; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/
 
#include <osmscout/lib/CoreImportExport.h>
 
#include <array>
#include <cstddef>
#include <string>
#include <tuple>
 
#include <osmscout/OSMScoutTypes.h>
 
#include <osmscout/util/Magnification.h>
#include <osmscout/util/Distance.h>
#include <osmscout/util/Bearing.h>
 
#include <osmscout/system/Math.h>
#include <osmscout/system/Compiler.h>
 
namespace osmscout {
  extern OSMSCOUT_API const double lonConversionFactor;

  extern OSMSCOUT_API const double latConversionFactor;
 
  constexpr uint32_t maxRawCoordValue = 0x7FFFFFF; // 134217727

  const size_t coordByteSize=7;

  class OSMSCOUT_API GeoCoord CLASS_FINAL
  {
  private:
    double lat = 0.0;
    double lon = 0.0;
 
  public:
    using GeoCoordBuffer = std::array<std::byte,7>;
 
    static constexpr int MinLatitude = -90;
    static constexpr int MaxLatitude = 90;
    static constexpr int MinLongitude = -180;
    static constexpr int MaxLongitude = 180;
 
  public:
    GeoCoord() = default;
 
    GeoCoord(const GeoCoord& other) = default;

    GeoCoord(double lat,
             double lon)
     :lat(lat),lon(lon)
    {
      // no code
    }

    void Set(double lat,
             double lon)
    {
      this->lat=lat;
      this->lon=lon;
    }

    double GetLat() const
    {
      return lat;
    }

    double GetLon() const
    {
      return lon;
    }

    std::string GetDisplayText() const;
 
    std::ostream& operator<<(std::ostream& stream) const
    {
      stream << GetDisplayText();
      return stream;
    }

    Id GetId() const;

    void EncodeToBuffer(GeoCoordBuffer& buffer) const // NOLINT
    {
      auto latValue=(uint32_t)round((lat+90.0)*latConversionFactor);
      auto lonValue=(uint32_t)round((lon+180.0)*lonConversionFactor);
 
      buffer[0]=std:: byte(latValue >>  0u);
      buffer[1]=std::byte(latValue >>  8u);
      buffer[2]=std::byte(latValue >> 16u);
 
      buffer[3]=std::byte(lonValue >>  0u);
      buffer[4]=std::byte(lonValue >>  8u);
      buffer[5]=std::byte(lonValue >> 16u);
 
      buffer[6]=std::byte((latValue >> 24u) & 0x07u) | std::byte((lonValue >> 20u) & 0x70u);
    }

    Id GetHash() const
    {
      auto     latValue=(uint64_t)round((lat+90.0)*latConversionFactor);
      auto     lonValue=(uint64_t)round((lon+180.0)*lonConversionFactor);
      uint64_t number  =0;
 
      for (size_t i=0; i<27; i++) {
        size_t bit=26-i;
 
        number=number << 1u;
        number=number+((latValue >> bit) & 0x01u);
 
        number=number << 1u;
        number=number+((lonValue >> bit) & 0x01u);
      }
 
      return number;
    }

    bool IsEqual(const GeoCoord& other) const
    {
      return lat==other.lat && lon==other.lon;
    }

    bool IsValid() const
    {
      return lat >= MinLatitude && lat <= MaxLatitude &&
             lon >= MinLongitude && lon <= MaxLongitude;
    }

    static bool Parse(const std::string& text,
                      GeoCoord& coord);

    Distance GetDistance(const GeoCoord &target) const;

    GeoCoord Add(const Bearing &bearing, const Distance &distance) const;

    bool operator==(const GeoCoord& other) const
    {
      return lat==other.lat && lon==other.lon;
    }

    bool operator!=(const GeoCoord& other) const
    {
      return lat!=other.lat || lon!=other.lon;
    }
 
    bool operator<(const GeoCoord& other) const
    {
      return std::tie(lat, lon) < std::tie(other.lat, other.lon);
    }

    GeoCoord& operator=(const GeoCoord& other) = default;
 
    Distance operator-(const GeoCoord& other) const
    {
      return GetDistance(other);
    }
  };
}
 
#endif