FMTCoordinate.h

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
 
#ifndef FMTCOORD_Hm_included
#define FMTCOORD_Hm_included
 
#include <memory>
#include <boost/unordered_map.hpp>
#include <vector>
#include <array>
#include <boost/serialization/serialization.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/array.hpp>
#include <string>
#include <set>
#include "FMTException.h"
 
namespace Spatial
    {
    // DocString: FMTCoordinate
    class FMTEXPORT FMTCoordinate
        {
        public:
            // DocString: FMTCoordinate()
            FMTCoordinate();
            // DocString: ~FMTCoordinate()
            ~FMTCoordinate() = default;
            // DocString: FMTCoordinate(uint16_t, uint16_t)
            FMTCoordinate(uint16_t p_x, uint16_t p_y);
            // DocString: FMTCoordinate(const FMTCoordinate&)
            FMTCoordinate(const FMTCoordinate& rhs);
            // DocString: FMTCoordinate::at
            FMTCoordinate at(unsigned int id) const;
            // DocString: FMTCoordinate::distance
            double distance(const FMTCoordinate& coord) const;
            // DocString: FMTCoordinate::within
            template<typename T>
            bool within(const T& ldistance, const FMTCoordinate& coord) const;
            // DocString: FMTCoordinate::upEnveloppe
            void upEnveloppe(std::array<FMTCoordinate, 4>& enveloppe) const;
            // DocString: FMTCoordinate::hash
            size_t hash() const;
            // DocString: FMTCoordinate::operator=
            FMTCoordinate& operator = (const FMTCoordinate& rhs);
            // DocString: FMTCoordinate::getSpatialCoordinate
            const std::vector<double> getSpatialCoordinate(std::vector<double> geoTransform) const;
            // DocString: FMTCoordinate::operator==
            bool operator == (const FMTCoordinate& rhs) const;
            // DocString: FMTCoordinate::operator<
            bool operator < (const FMTCoordinate& rhs) const;
            // DocString: FMTCoordinate::closest
            std::set<FMTCoordinate>::const_iterator closest(const std::vector<std::set<FMTCoordinate>::const_iterator>& coordinates, double& approximation) const;
            // DocString: FMTCoordinate::operator std::string
            operator std::string() const;
            // DocString: FMTCoordinate::getNeighbors
            std::set<FMTCoordinate> getNeighbors(const uint16_t& nsize, const bool& circle = false) const;
            // DocString: FMTCoordinate::getAverageCentroid
            static FMTCoordinate getAverageCentroid(const std::array<FMTCoordinate, 4>& p_enveloppe);
            // DocString: FMTCoordinate::getTerritory
            static std::set<FMTCoordinate> getTerritory(const std::array<FMTCoordinate, 4>& p_enveloppe, const size_t& p_distance);
            // DocString: FMTCoordinate::getHeight
            static size_t getHeight(const std::array<FMTCoordinate, 4>& p_enveloppe);
            // DocString: FMTCoordinate::getWidth
            static size_t getWidth(const std::array<FMTCoordinate, 4>& p_enveloppe);
            // DocString: FMTCoordinate::getX
            uint16_t getX() const;
            // DocString: FMTCoordinate::getY
            uint16_t getY() const;
        private:
            friend class boost::serialization::access;
            //unsigned int x,y;
            uint16_t m_x;
            uint16_t m_y;
            // DocString: FMTCoordinate::serialize
            template<class Archive>
            void serialize(Archive& ar, const unsigned int version)
                {
                ar & BOOST_SERIALIZATION_NVP(m_x);
                ar & BOOST_SERIALIZATION_NVP(m_y);
                }
            // DocString: FMTCoordinate::_getXyGap
            void _getXyGap(const FMTCoordinate& rhs, int& xgap, int& y_gap) const;
            // DocString: FMTCoordinate::_distanceApproximation
            double _distanceApproximation(const FMTCoordinate& coord) const;
 
        };
    }
 
namespace boost {
 
  template <>
  struct hash<Spatial::FMTCoordinate>
  {
    std::size_t operator()(const Spatial::FMTCoordinate& p_coord) const
        {
        //unsigned int x = coord.getX();
        //unsigned int y = coord.getY();
        //return (boost::hash<unsigned int>()(x) && hash<unsigned int>()(y));
        return p_coord.hash();
        }
  };
 
}
 
#endif // FMTCOORD_Hm_included