vcs.maemo.org Git - situare/blob - src/gps/gpspositionmockup.h

   1 /*
   2    Situare - A location system for Facebook
   3    Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5        Jussi Laitinen - jussi.laitinen@ixonos.com
   6
   7    Situare is free software; you can redistribute it and/or
   8    modify it under the terms of the GNU General Public License
   9    version 2 as published by the Free Software Foundation.
  10
  11    Situare is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with Situare; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  19    USA.
  20 */
  21
  22 #ifndef GPSPOSITIONMOCKUP_H
  23 #define GPSPOSITIONMOCKUP_H
  24
  25 #include "gpspositioninterface.h"
  26
  27 /**
  28 * @brief GPSPositionMockup class does nothing.
  29 *
  30 * Class is used when compiling in desktop.
  31 */
  32 class GPSPositionMockup : public GPSPositionInterface
  33 {
  34     Q_OBJECT
  35
  36 public:
  37     /**
  38     * @brief Constructor.
  39     *
  40     * @param parent QObject
  41     */
  42     GPSPositionMockup(QObject *parent = 0);
  43
  44     /**
  45     * @brief Destructor.
  46     */
  47     ~GPSPositionMockup();
  48
  49 /******************************************************************************
  50 * MEMBER FUNCTIONS AND SLOTS
  51 ******************************************************************************/
  52 public:
  53     /**
  54     * @brief Checks if GPS is running.
  55     *
  56     * RETURNS FALSE.
  57     * @return true if GPS running, false otherwise
  58     */
  59     bool isRunning();
  60
  61     /**
  62     * @brief Informs gps to emit last known position.
  63     *
  64     * DOES NOTHING.
  65     */
  66     void lastPosition();
  67
  68     /**
  69     * @brief Set GPS update interval.
  70     *
  71     * DOES NOTHING.
  72     * @return interval interval in milliseconds
  73     */
  74     void setUpdateInterval(int interval);
  75
  76     /**
  77     * @brief Set GPS mode.
  78     *
  79     * DOES NOTHING.
  80     * @param mode GPS mode
  81     * @param filePath file path to NMEA file if simulation mode is used
  82     */
  83     void setMode(Mode mode, const QString &filePath = 0);
  84
  85     /**
  86     * @brief Start GPS.
  87     *
  88     * DOES NOTHING.
  89     */
  90     void start();
  91
  92     /**
  93     * @brief Stop GPS.
  94     *
  95     * DOES NOTHING.
  96     */
  97     void stop();
  98
  99 private slots:
 100     /**
 101     * @brief Slot for GPS update request.
 102     *
 103     * DOES NOTHING.
 104     */
 105     void update();
 106 };
 107
 108 #endif // GPSPOSITIONMOCKUP_H