geo-coordinate.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Sami Rantanen <sami.rantanen@magister.fi>
 */
#ifndef GEO_COORDINATE_H
#define GEO_COORDINATE_H
 
#include "ns3/attribute-helper.h"
#include "ns3/attribute.h"
#include "ns3/vector.h"
 
#include <istream>
#include <ostream>
 
namespace ns3
{

class GeoCoordinate
{
  public:
    typedef enum
    {
        SPHERE,
        WGS84,
        GRS80
    } ReferenceEllipsoid_t;

    GeoCoordinate(double latitude,
                  double longitude,
                  double altitude,
                  bool correctIfInvalid = false);

    GeoCoordinate(double latitude,
                  double longitude,
                  double altitude,
                  ReferenceEllipsoid_t refEllipsoid,
                  bool correctIfInvalid = false);

    GeoCoordinate(Vector vector);

    GeoCoordinate(Vector vector, ReferenceEllipsoid_t refEllipsoid);

    GeoCoordinate();

    ReferenceEllipsoid_t GetRefEllipsoid()
    {
        return m_refEllipsoid;
    }

    double GetLongitude() const;
    double GetLatitude() const;
    double GetAltitude() const;
    void SetLongitude(double longitude);
    void SetLatitude(double latitude);
    void SetAltitude(double altitude);
    Vector ToVector() const;
 
    // Definitions for reference Earth Ellipsoid parameters.
    // Sphere, WGS84 and GRS80 reference ellipsoides supported.
 
    // length (in meters) for semi-minor axis A. (same for all reference ellipsoides)
    static constexpr double equatorRadius = 6378137.0;
 
    // length (in meters) for semi-minor axis B
    static constexpr double polarRadius_sphere = 6378137.0;     // Sphere
    static constexpr double polarRadius_wgs84 = 6356752.314245; // WGS84 ellipsoide
    static constexpr double polarRadius_grs80 = 6356752.314103; // GRS80 ellipsoide
 
  private:
    double GetRadiusCurvature(double latitude) const;

    static inline bool IsValidLongitude(double longitude)
    {
        return (longitude >= -180 && longitude <= 180);
    }

    static inline bool IsValidLatitude(double latitude)
    {
        return (latitude >= -90 && latitude <= 90);
    }

    static inline bool IsValidAltitude(double altitude, ReferenceEllipsoid_t refEllipsoide);
    void ConstructFromVector(const Vector& vector);

    void Construct(double latitude, double longitude, double altitude, bool correctIfInvalid);

    void Initialize();

    double m_latitude;
    double m_longitude;
    double m_altitude;
 
    ReferenceEllipsoid_t m_refEllipsoid; // reference ellipsoid
    double m_e2Param;                    // First eccentricity squared
    double m_equatorRadius;              // Semi-major axis A, meters
    double m_polarRadius;                // Semi-major axis B, meters
};

ATTRIBUTE_HELPER_HEADER(GeoCoordinate);
 
std::ostream& operator<<(std::ostream& os, const GeoCoordinate& coordinate);
std::istream& operator>>(std::istream& is, GeoCoordinate& coordinate);
 
Ptr<const AttributeChecker> MakeGeoCoordinateChecker(void);
 
} // namespace ns3
 
#endif /* GEO_COORDINATE_H */