Coords.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2009 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO 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 3 of the License, or
    (at your option) any later version.
 
    MeteoIO 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 MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef COORDS_H
#define COORDS_H
 
#include <string>
#include <iostream>
#include <set>
 
namespace mio {
class Coords {
        public:
                typedef enum GEO_DISTANCES {
                        NONE, 
                        GEO_COSINE, 
                        GEO_VINCENTY 
                } geo_distances;
                
                typedef enum {
                        DEBUG, 
                        FULL, 
                        LATLON, 
                        XY, 
                        CARTESIAN 
                } FORMATS;
 
                //Constructors
                Coords();
                Coords(const std::string& in_coordinatesystem, const std::string& in_parameters="");
                Coords(const std::string& in_coordinatesystem, const std::string& in_parameters, std::string coord_spec);
                Coords(const double& in_lat_ref, const double& in_long_ref);
                Coords(const Coords& c);
 
                //Operators
                Coords& operator=(const Coords&); 
                bool operator==(const Coords&) const; 
                bool operator!=(const Coords&) const; 
                bool isNodata() const;
                void moveByXY(const double& x_displacement, const double& y_displacement);
                void moveByBearing(const double& i_bearing, const double& i_distance);
 
                static Coords merge(const Coords& coord1, const Coords& coord2);
                void merge(const Coords& coord2);
 
                //Getter methods
                double getEasting() const {return easting;}
                double getNorthing() const {return northing;}
                double getLat() const {return latitude;}
                double getLon() const {return longitude;}
                double getAltitude() const {return altitude;}
                int getGridI() const {return grid_i;}
                int getGridJ() const {return grid_j;}
                int getGridK() const {return grid_k;}
                bool indexIsValid() const {return validIndex;} 
                void getProj(std::string& proj_type, std::string& proj_args) const;
                short int getEPSG() const;
 
                const std::string toString(const FORMATS& type = DEBUG) const;
                friend std::ostream& operator<<(std::ostream& os, const Coords& coord);
                friend std::istream& operator>>(std::istream& is, Coords& coord);
                bool operator<(const Coords& in) const;
 
                //Setter methods
                void setLatLon(const double in_latitude, const double in_longitude, const double in_altitude, const bool in_update=true);
                void setLatLon(const std::string& in_coordinates, const double in_altitude, const bool in_update=true);
                void setXY(const double in_easting, const double in_northing, const double in_altitude, const bool in_update=true);
                void setPoint(const double in_x_or_lat, const double in_y_or_lon, const double in_altitude);
                void setPoint(const double in_x_or_lat, const double in_y_or_lon, const double in_altitude, const int epsg);
                void setGridIndex(const int in_grid_i, const int in_grid_j, const int in_grid_k, const bool setValid=false);
                void setAltitude(const double in_altitude, const bool in_update=true);
                void setProj(const std::string& in_coordinatesystem, const std::string& in_parameters="");
                void setLocalRef(const double in_ref_latitude, const double in_ref_longitude);
                void setLocalRef(const std::string in_coordparam);
                void setDistances(const geo_distances in_algo);
                void setEPSG(const int& epsg);
 
                void check(const std::string& pre_msg="");
                double distance(const Coords& destination) const;
                bool isSameProj(const Coords& target) const;
                void copyProj(const Coords& source, const bool i_update=true);
 
        private:
                //Coordinates conversions
                void convert_to_WGS84(double i_easting, double i_northing, double& o_latitude, double& o_longitude) const;
                void convert_from_WGS84(double i_latitude, double i_longitude, double& o_easting, double& o_northing) const;
 
                void WGS84_to_local(double lat_in, double long_in, double& east_out, double& north_out) const;
                void local_to_WGS84(double east_in, double north_in, double& lat_out, double& long_out) const;
                void WGS84_to_NULL(double lat_in, double long_in, double& east_out, double& north_out) const;
                void NULL_to_WGS84(double east_in, double north_in, double& lat_out, double& long_out) const;
 
                //Distances calculations
                void distance(const Coords& destination, double& o_distance, double& o_bearing) const;
 
        private:
                void clearCoordinates();
                void setDefaultValues();
                bool isConsistent() const;
 
        private:
                double ref_latitude, ref_longitude;
                double altitude; 
                double latitude, longitude; 
                double easting, northing; 
                int grid_i, grid_j, grid_k; 
                bool validIndex; 
 
                std::string coordsystem, coordparam;
                geo_distances distance_algo;
        
        public:
                static const std::set<int> latlon_epsgs;
 
};
} //end namespace
 
#endif