git.maemo.org Git - ptas/blob - include/qgeocoordinate.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the Qt Mobility Components.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41 #ifndef QGEOCOORDINATE_H
  42 #define QGEOCOORDINATE_H
  43
  44 #include "qmobilityglobal.h"
  45
  46 #include <QString>
  47
  48 QT_BEGIN_NAMESPACE
  49 class QDebug;
  50 class QDataStream;
  51 QT_END_NAMESPACE
  52
  53 QT_BEGIN_HEADER
  54
  55 QTM_BEGIN_NAMESPACE
  56
  57 class QGeoCoordinatePrivate;
  58 class Q_LOCATION_EXPORT QGeoCoordinate
  59 {
  60 public:
  61     enum CoordinateType {
  62         InvalidCoordinate,
  63         Coordinate2D,
  64         Coordinate3D
  65     };
  66
  67     enum CoordinateFormat {
  68         Degrees,
  69         DegreesWithHemisphere,
  70         DegreesMinutes,
  71         DegreesMinutesWithHemisphere,
  72         DegreesMinutesSeconds,
  73         DegreesMinutesSecondsWithHemisphere
  74     };
  75
  76     QGeoCoordinate();
  77     QGeoCoordinate(double latitude, double longitude);
  78     QGeoCoordinate(double latitude, double longitude, double altitude);
  79     QGeoCoordinate(const QGeoCoordinate &other);
  80     ~QGeoCoordinate();
  81
  82     QGeoCoordinate &operator=(const QGeoCoordinate &other);
  83
  84     bool operator==(const QGeoCoordinate &other) const;
  85     inline bool operator!=(const QGeoCoordinate &other) const {
  86         return !operator==(other);
  87     }
  88
  89     bool isValid() const;
  90     CoordinateType type() const;
  91
  92     void setLatitude(double latitude);
  93     double latitude() const;
  94
  95     void setLongitude(double longitude);
  96     double longitude() const;
  97
  98     void setAltitude(double altitude);
  99     double altitude() const;
 100
 101     qreal distanceTo(const QGeoCoordinate &other) const;
 102     qreal azimuthTo(const QGeoCoordinate &other) const;
 103
 104     QString toString(CoordinateFormat format = DegreesMinutesSecondsWithHemisphere) const;
 105
 106 private:
 107     QGeoCoordinatePrivate *d;
 108 };
 109
 110 #ifndef QT_NO_DEBUG_STREAM
 111 Q_LOCATION_EXPORT QDebug operator<<(QDebug, const QGeoCoordinate &);
 112 #endif
 113
 114 #ifndef QT_NO_DATASTREAM
 115 Q_LOCATION_EXPORT QDataStream &operator<<(QDataStream &stream, const QGeoCoordinate &coordinate);
 116 Q_LOCATION_EXPORT QDataStream &operator>>(QDataStream &stream, QGeoCoordinate &coordinate);
 117 #endif
 118
 119 QTM_END_NAMESPACE
 120
 121 QT_END_HEADER
 122
 123 #endif