geo/tcGeo.h

   1 /***************************************************************************
   2  *   This file is part of Tecorrec.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   Tecorrec is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   Tecorrec is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with Tecorrec.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _tcGeo_h_
  21 #define _tcGeo_h_
  22
  23 /**
  24  * @file tcGeo.h
  25  * @brief Geographical coordinates.
  26  */
  27
  28 /// Use doubles for angles.
  29 typedef double tcGeoAngle;
  30
  31 /// Geographical coordinates.
  32 class tcGeo
  33 {
  34   public:
  35
  36     /*
  37      * Constructors + destructor
  38      */
  39
  40     /// Primary constructor.
  41     tcGeo()
  42     : m_longitude(0.0)
  43     , m_latitude(0.0)
  44     {
  45     }
  46
  47     /// Primary constructor.
  48     tcGeo(const tcGeoAngle lon, const tcGeoAngle lat)
  49     : m_longitude(lon)
  50     , m_latitude(lat)
  51     {
  52     }
  53
  54     /*
  55      * Accessors
  56      */
  57
  58     /// Get the longitude.
  59     tcGeoAngle lon() const
  60     {
  61       return m_longitude;
  62     }
  63
  64     /// Get the latitude.
  65     tcGeoAngle lat() const
  66     {
  67       return m_latitude;
  68     }
  69
  70     /*
  71      * Mutators
  72      */
  73
  74     /// Set the longitude.
  75     void setLon(const tcGeoAngle lon)
  76     {
  77       m_longitude = lon;
  78     }
  79
  80     /// Set the latitude.
  81     void setLat(const tcGeoAngle lat)
  82     {
  83       m_latitude = lat;
  84     }
  85
  86     /// Set the longitude and latitude.
  87     void setLonLat(const tcGeoAngle lon, const tcGeoAngle lat)
  88     {
  89       m_longitude = lon;
  90       m_latitude = lat;
  91     }
  92
  93   private:
  94
  95     /*
  96      * Variables
  97      */
  98
  99     /** East-West geographical coordinate.
 100      * Units are radians.
 101      */
 102     tcGeoAngle m_longitude;
 103
 104     /** North-South geographical coordinate.
 105      * Units are radians.
 106      */
 107     tcGeoAngle m_latitude;
 108
 109 };
 110
 111 #endif // _tcGeo_h_
 112