Added unit tests to gps.
[situare] / 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 GPSPosition gpspositionmockup.h "gps/gpspositionmockup.h"
33 */
34 class GPSPositionMockup : public GPSPositionInterface
35 {
36     Q_OBJECT
37
38 public:
39     /**
40     * @brief Constructor.
41     *
42     * @param parent QObject
43     */
44     GPSPositionMockup(QObject *parent = 0);
45
46     /**
47     * @brief Destructor.
48     */
49     ~GPSPositionMockup();
50
51 /******************************************************************************
52 * MEMBER FUNCTIONS AND SLOTS
53 ******************************************************************************/
54 public:
55     /**
56     * @brief Checks if GPS is running.
57     *
58     * RETURNS FALSE.
59     * @return true if GPS running, false otherwise
60     */
61     bool isRunning();
62
63     /**
64     * @brief Informs gps to emit last known position.
65     *
66     * DOES NOTHING.
67     */
68     void lastPosition();
69
70     /**
71     * @brief Set GPS update interval.
72     *
73     * DOES NOTHING.
74     * @return interval interval in milliseconds
75     */
76     void setUpdateInterval(int interval);
77
78     void setMode(Mode mode, const QString &filePath = 0);
79
80     /**
81     * @brief Start GPS.
82     *
83     * DOES NOTHING.
84     */
85     void start();
86
87     /**
88     * @brief Stop GPS.
89     *
90     * DOES NOTHING.
91     */
92     void stop();
93
94 private slots:
95     /**
96     * @brief Slot for GPS update request.
97     *
98     * DOES NOTHING.
99     */
100     void update();
101 };
102
103 #endif // GPSPOSITIONMOCKUP_H