Adapts core/geo files to coding style. (#732)

This commit is the first of a series of coding style adapts
to follow for the olp/geo folder, which is based on a legacy
repository that was merged into this.
This commit adapts GeoCoordinates, GeoCoordinates3d, GeoPoint,
and GeoRectangle to coding style.

Relates-to: OLPEDGE-569

Signed-off-by: Andrei Popescu <[email protected]>

Author: Andrei Popescu

olp-cpp-sdk-core/include/olp/core/geo/coordinates/GeoCoordinates.h

@@ -25,6 +25,7 @@
 
 namespace olp {
 namespace geo {
+
 /**
  * @brief A geographic location using WGS84 coordinates.
  *
@@ -37,12 +38,13 @@ namespace geo {
 class CORE_API GeoCoordinates {
  public:
   /**
-   * @brief Construct default geo coordinates
+   * @brief Construct default invalid geo coordinates.
    */
   GeoCoordinates();
 
   /**
-   * @brief Construct geo coordinates form latitude and longitude
+   * @brief Construct geo coordinates form latitude and longitude.
+   *
    * @param latitude_radians WGS84 latitude in radians. Valid values are in
    * [-Pi/2, Pi/2] range.
    * @param longitude_radians WGS84 longitude in radians. Valid values are in
@@ -51,7 +53,8 @@ class CORE_API GeoCoordinates {
   GeoCoordinates(double latitude_radians, double longitude_radians);
 
   /**
-   * @brief Construct geo coordinates form latitude and longitude in degrees
+   * @brief Construct geo coordinates form latitude and longitude in degrees.
+   *
    * @param latitude_degrees WGS84 latitude in degrees. Valid values are in
    * [-90, 90] range.
    * @param longitude_degrees WGS84 longitude in degrees. Valid values are in
@@ -63,10 +66,12 @@ class CORE_API GeoCoordinates {
 
   /**
    * @brief Create GeoCoordinates from latitude and longitude in degrees.
+   *
    * @param latitude_degrees WGS84 latitude in degrees. Valid value is in [-90,
    * 90] range.
    * @param longitude_degrees WGS84 longitude in degrees. Valid value is in
    * [-180, 180) range.
+   *
    * @return GeoCoordinate based on specified input.
    * Use normalized() to put values in a valid range.
    */
@@ -75,33 +80,42 @@ class CORE_API GeoCoordinates {
 
   /**
    * @brief Create GeoCoordinates from GeoPoint.
+   *
    * @param geo_point Geo point to convert to.
+   *
    * @return GeoCoordinate based on specified geoPoint.
    */
   static GeoCoordinates FromGeoPoint(const GeoPoint& geo_point);
 
   /**
    * @brief Return geo coordinate as GeoPoint.
+   *
    * @return current coordinate as a GeoPoint.
    */
   GeoPoint ToGeoPoint() const;
 
   /**
    * @brief Return WGS84 latitude in radians.
+   *
    * @return WGS84 latitude in radians.
    */
   double GetLatitude() const;
+
   /**
    * @brief Set latitude in radians.
+   *
    * @param latitude_radians WGS84 latitude in radians. Valid values are in
    * [-Pi/2, Pi/2] range.
    */
   void SetLatitude(double latitude_radians);
+
   /**
    * @brief Return WGS84 longitude in radians.
+   *
    * @return WGS84 longitude in radians.
    */
   double GetLongitude() const;
+
   /**
    * @brief Set longitude in radians.
    * @param longitude_radians WGS84 longitude in radians. Valid values are in
@@ -111,54 +125,78 @@ class CORE_API GeoCoordinates {
 
   /**
    * @brief Return WGS84 latitude in degrees.
+   *
    * @return WGS84 latitude in degrees.
    */
   double GetLatitudeDegrees() const;
 
   /**
    * @brief Set latitude in degrees.
+   *
    * @param latitude_degrees WGS84 latitude in degrees. Valid values are in
    * [-90, 90] range.
    */
   void SetLatitudeDegrees(double latitude_degrees);
+
   /**
    * @brief Return WGS84 longitude in degrees.
+   *
    * @return WGS84 longitude in degrees.
    */
   double GetLongitudeDegrees() const;
+
   /**
    * @brief Set longitude in degrees.
+   *
    * @param longitude_degrees WGS84 longitude in degrees. Valid values are in
    * [-180, 180) range.
    */
   void SetLongitudeDegrees(double longitude_degrees);
 
   /**
    * @brief Normalize the latitude and longitude to [-Pi/2, Pi/2], [-Pi, Pi)
-   * range. To that end, longitude wraps around at +/- Pi and latitude is
-   * clamped at +/- Pi/2
+   * range.
+   *
+   * To that end, longitude wraps around at +/- Pi and latitude is clamped at
+   * +/- Pi/2.
    */
   GeoCoordinates Normalized() const;
+
   /**
-   * @brief Overload the bool operator. Return true if the coordinates are valid.
+   * @brief Overload the bool operator.
+   *
+   * Returns true if the coordinates are valid.
+   *
    * @see IsValid
    */
   explicit operator bool() const;
+
   /**
    * @brief Check if the radian values of latitude and longitude are valid
-   * double numbers. The check happens with the help of math::isnan.
+   * double numbers.
+   *
+   * The check happens with the help of math::isnan.
+   *
    * @return true if the result of the check is positive,
    * false if it is negative.
    */
   bool IsValid() const;
 
  private:
-  double latitude_;   ///< Latitude in radians.
-  double longitude_;  ///< Longitude in radians.
+  /// Latitude in radians.
+  double latitude_;
+  /// Longitude in radians.
+  double longitude_;
+  /// Const used to signalize an invalid value latitude or longitude.
   static const double kNaN_;
 };
 
-bool operator==(const GeoCoordinates& lhs, const GeoCoordinates& rhs);
+/**
+ * @brief Compare operator for comparing two coordinates with each other.
+ *
+ * @return true if the two GeoCoordinates are equal, false otherwise.
+ */
+CORE_API bool operator==(const GeoCoordinates& lhs, const GeoCoordinates& rhs);
 
 }  // namespace geo
 }  // namespace olp

olp-cpp-sdk-core/include/olp/core/geo/coordinates/GeoCoordinates3d.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,19 +24,23 @@
 
 namespace olp {
 namespace geo {
+
 /**
  * Geodetic coordinates with longitude, latitude and altitude.
  */
 class CORE_API GeoCoordinates3d {
  public:
   /**
-   * Construct invalid geodetic coordinates.
+   * @brief Construct invalid geodetic coordinates.
+   *
    * @post Latitude, longitude and altitude are undefined (NaN).
    */
   GeoCoordinates3d();
 
   /**
-   * Construct geodetic coordinates from latitude, longitude and altitude.
+   * @brief Construct geodetic coordinates from latitude, longitude and
+   * altitude.
+   *
    * @param[in] latitude_radians Latitude in radians.
    * @param[in] longitude_radians Longitude in radians.
    * @param[in] altitude_meters Altitude in meters.
@@ -45,133 +49,151 @@ class CORE_API GeoCoordinates3d {
                    double altitude_meters);
 
   /**
-   * Construct geodetic coordinates from latitude, longitude and altitude.
+   * @brief Construct geodetic coordinates from latitude, longitude and
+   * altitude.
+   *
    * @param[in] latitudeDegrees Latitude in degrees.
    * @param[in] longitudeDegrees Longitude in degrees.
    * @param[in] altitude_meters Altitude in meters.
    * @param[in] degrees Degree tag.
    */
-  GeoCoordinates3d(double latitudeDegrees, double longitudeDegrees,
+  GeoCoordinates3d(double latitude_degrees, double longitude_degrees,
                    double altitude_meters, DegreeType degrees);
 
   /**
-   * Construct geodetic coordinates from 2D coordinates with undefined altitude.
+   * @brief Construct geodetic coordinates from 2D coordinates with undefined
+   * altitude.
+   *
    * @param[in] geo_coordinates 2D geodetic coordinates.
    * @post Altitude is undefined (NaN).
    */
   explicit GeoCoordinates3d(const GeoCoordinates& geo_coordinates);
 
   /**
-   * Construct geodetic coordinates from 2D coordinates and an altitude.
+   * @brief Construct geodetic coordinates from 2D coordinates and an altitude.
+   *
    * @param[in] geo_coordinates 2D geodetic coordinates.
    * @param[in] altitude_meters Altitude in meters.
    */
   GeoCoordinates3d(const GeoCoordinates& geo_coordinates,
                    double altitude_meters);
 
   /**
-   * Create geodetic coordinates from latitude and longitude in degrees.
+   * @brief Create geodetic coordinates from latitude and longitude in degrees.
+   *
    * @param[in] latitude Latitude in degrees.
    * @param[in] longitude Longitude in degrees.
    * @param[in] altitude Altitude in meters.
    * @return Geodetic coordinates.
    */
-  static GeoCoordinates3d FromDegrees(double latitude,
-                                      double longitude,
+  static GeoCoordinates3d FromDegrees(double latitude, double longitude,
                                       double altitude = 0.0);
 
   /**
-   * Create geodetic coordinates from latitude and longitude in radians.
+   * @brief Create geodetic coordinates from latitude and longitude in radians.
+   *
    * @param[in] latitude Latitude in radians.
    * @param[in] longitude Longitude in radians.
    * @param[in] altitude Altitude in meters.
    * @return Geodetic coordinates.
    */
-  static GeoCoordinates3d FromRadians(double latitude,
-                                      double longitude,
+  static GeoCoordinates3d FromRadians(double latitude, double longitude,
                                       double altitude = 0.0);
 
   /**
    * @brief Get latitude and longitude as 2D geodetic coordinates.
+   *
    * @return 2D geodetic coordinates.
    */
   const GeoCoordinates& GetGeoCoordinates() const;
 
   /**
    * @brief Set latitude and longitude from 2D geodetic coordinates.
+   *
    * @param[in] geo_coordinates 2D geodetic coordinates.
    */
   void SetGeoCoordinates(const GeoCoordinates& geo_coordinates);
 
   /**
    * @brief Get latitude.
+   *
    * @return Latitude in radians.
    */
   double GetLatitude() const;
 
   /**
-   * Set latitude.
+   * @brief Set latitude.
+   *
    * @param[in] latitude_radians Latitude in radians.
    */
   void SetLatitude(double latitude_radians);
 
   /**
-   * Get longitude.
+   * @brief Get longitude.
+   *
    * @return Longitude in radians.
    */
   double GetLongitude() const;
 
   /**
-   * Set longitude.
+   * @brief Set longitude.
+   *
    * @param[in] longitude_radians Longitude in radians.
    */
   void SetLongitude(double longitude_radians);
 
   /**
-   * Get latitude in degrees.
+   * @brief Get latitude in degrees.
+   *
    * @return Latitude in degrees.
    */
   double GetLatitudeDegrees() const;
 
   /**
-   * Set latitude in degrees.
+   * @brief Set latitude in degrees.
+   *
    * @param[in] latitude_degrees Latitude in degrees.
    */
   void setLatitudeDegrees(double latitude_degrees);
 
   /**
-   * Get longitude in degrees.
+   * @brief Get longitude in degrees.
    * @return Longitude in degrees.
    */
   double GetLongitudeDegrees() const;
 
   /**
-   * Set longitude in degrees.
+   * @brief Set longitude in degrees.
+   *
    * @param[in] longitude_degrees Longitude in degrees.
    */
   void SetLongitudeDegrees(double longitude_degrees);
 
   /**
-   * Get altitude.
+   * @brief Get altitude.
+   *
    * @return Altitude in meters.
    */
   double GetAltitude() const;
 
   /**
-   * Set altitude.
+   * @brief Set altitude.
+   *
    * @param[in] altitude_meters Altitude in meters.
    */
   void SetAltitude(double altitude_meters);
 
   /**
-   * Check whether coordinates and altitude are valid.
+   * @brief Check whether coordinates and altitude are valid.
+   *
    * @return True if all valid, false if latitude, longitude or altitude is
    * undefined.
    */
   explicit operator bool() const;
 
   /**
-   * Check whether coordinates and altitude are valid.
+   * @brief Check whether coordinates and altitude are valid.
+   *
    * @return True if all valid, false if latitude, longitude or altitude is
    * undefined.
    */