Modified automatic location update method.

[situare] / src / engine / engine.h

diff --git a/src/engine/engine.h b/src/engine/engine.h
index 5ced8e2..19d8a7b 100644 (file)
--- a/src/engine/engine.h
+++ b/src/engine/engine.h
@@ -26,14 +26,22 @@
 #ifndef ENGINE_H
 #define ENGINE_H
 
-#include <QWidget>
-#include <QtDebug>
-#include "facebookservice/facebookauthentication.h"
-#include "situareservice/situareservice.h"
-#include "ui/mainwindow.h"
+#include <QObject>
+#include <QTime>
+#include <QPointF>
 
-class GPSPositionInterface;
+class QMainWindow;
+
+class FacebookAuthentication;
+class FacebookCredentials;
+class GPSPosition;
+class MainWindow;
 class MapEngine;
+class SituareService;
+class User;
+class MCE;
+
+class QTimer;
 
 /**
 * @brief Engine class for Situare Application
@@ -66,10 +74,23 @@ public slots:
     *
     * @param error Error message
     */
-    void error(const QString &error);
+    void error(const int error);
+
+    /**
+    * @brief Slot to intercept signal when username is fetched from settings
+    *
+    */
+    void fetchUsernameFromSettings();
+
+    /**
+    * @brief Slot to intercept signal when Login/Logout action is pressed
+    *
+    */
+    void loginActionPressed();
 
     /**
     * @brief Slot to intercept signal from successful login
+    *
     */
     void loginOk();
 
@@ -79,6 +100,12 @@ public slots:
     void loginProcessCancelled();
 
     /**
+    * @brief Changes application state when logged out
+    *
+    */
+    void logout();
+
+    /**
     * @brief Calls reverseGeo from SituareService to translate coordinates to street address
     *
     */
@@ -91,7 +118,7 @@ public slots:
     * @param status Status message
     * @param publish Publish on Facebook
     */
-    void requestUpdateLocation(const QString &status, bool publish);
+    void requestUpdateLocation(const QString &status = QString(), bool publish = false);
 
     /**
     * @brief Slot to refresh user data
@@ -115,6 +142,12 @@ public slots:
 
 private:
     /**
+    * @brief Read settings and determine whether to use GPS and autocentering.
+    * When values does not found on the settings, GPS and autocentering are enabled as a default.
+    */
+    void initializeGpsAndAutocentering();
+
+    /**
       * @brief Connect signals coming from Facdebook authenticator
       */
     void signalsFromFacebookAuthenticator();
@@ -146,13 +179,22 @@ private:
 
 private slots:
     /**
-      * @brief Set auto centering feature enabled / disabled
-      */
+    * @brief Automatic update interval timer timeout.
+    *
+    * Requests update location if user has moved.
+    */
+    void automaticUpdateIntervalTimerTimeout();
+
+    /**
+    * @brief Set auto centering feature enabled / disabled
+    *
+    * @param enabled true if enabled, false otherwise
+    */
     void changeAutoCenteringSetting(bool enabled);
 
     /**
-      * @brief Slot for disabling automatic centering when map is scrolled manually
-      */
+    * @brief Slot for disabling automatic centering when map is scrolled manually
+    */
     void disableAutoCentering();
 
     /**
@@ -171,10 +213,55 @@ private slots:
     */
     void enableGPS(bool enabled);
 
+    /**
+    * @brief Enables automatic location update.
+    *
+    * @param enabled true if enabled, false otherwise
+    * @param updateIntervalMsecs update interval in milliseconds
+    */
+    void enableAutomaticLocationUpdate(bool enabled, int updateIntervalMsecs = 0);
+
+    /**
+    * @brief Slot for display on.
+    *
+    * @param on true if on, false otherwise
+    */
+    void displayOn(bool on);
+
+    /**
+     * @brief Sets zoom level to default when first GPS location is received if autocentering
+     * is enabled.
+     *
+     * @param latLonCoordinate own location
+     * @param accuracy accuracy of GPS location
+     */
+    void setFirstStartZoomLevel(QPointF latLonCoordinate, qreal accuracy);
+
+    /**
+    * @brief Saves GPS position.
+    *
+    * Saves GPS position if it has changed enough and sets m_userMoved flag.
+    *
+    * @param position geo coordinates
+    */
+    void saveGPSPosition(QPointF position);
+
 /*******************************************************************************
  * SIGNALS
  ******************************************************************************/
 signals:
+    /**
+    * @brief Signals when automatic location update was enabled.
+    *
+    * @param enabled true if enabled, false otherwise
+    */
+    void automaticLocationUpdateEnabled(bool enabled);
+
+    /**
+    * @brief Signal to clear locationUpdateDialog's data
+    *
+    */
+    void clearUpdateLocationDialogData();
 
     /**
     * @brief Signals when new friends data is ready
@@ -194,15 +281,21 @@ signals:
  * DATA MEMBERS
  ******************************************************************************/
 private:
-    bool m_autoCenteringEnabled;  ///< Auto centering enabled
+    bool m_autoCenteringEnabled;        ///< Auto centering flag
+    bool m_automaticUpdateFirstStart;   ///< Automatic location update first start flag
+    bool m_automaticUpdateRequest;      ///< Flag for automatic update request
+    bool m_userMoved;                   ///< Flag for user move
 
-    QPointF m_latestLocation;     ///< Placeholder for user's latest asked location
 
     FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
-    GPSPositionInterface *m_gps;                     ///< Instance of the gps position
+    GPSPosition *m_gps;                              ///< Instance of the gps position
     MainWindow *m_ui;                                ///< Instance of the MainWindow UI
     MapEngine *m_mapEngine;                          ///< MapEngine
     SituareService *m_situareService;  ///< Instance of the situare server communication service
+    MCE *m_mce;                        ///< Instance of the MCE
+
+    QTimer *m_automaticUpdateIntervalTimer; ///< Automatic update interval timer
+    QPointF m_lastUpdatedGPSPosition;       ///< Last updated GPS position
 };
 
 #endif // ENGINE_H