Power save mode review and iteration.

[situare] / src / engine / engine.h

diff --git a/src/engine/engine.h b/src/engine/engine.h
index 64f4015..fd66a99 100644 (file)
--- a/src/engine/engine.h
+++ b/src/engine/engine.h
@@ -27,6 +27,7 @@
 #define ENGINE_H
 
 #include <QObject>
+#include <QTime>
 #include <QPointF>
 
 class QMainWindow;
@@ -38,6 +39,9 @@ class MainWindow;
 class MapEngine;
 class SituareService;
 class User;
+class MCE;
+
+class QTimer;
 
 /**
 * @brief Engine class for Situare Application
@@ -70,7 +74,7 @@ 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
@@ -87,10 +91,8 @@ public slots:
     /**
     * @brief Slot to intercept signal from successful login
     *
-    * @param freshLogin Was login done via login dialog
-    * @param credentials Facebook credentials
     */
-    void loginOk(bool freshLogin, const FacebookCredentials &credentials);
+    void loginOk();
 
     /**
     * @brief Slot to intercept signal when user has cancelled login process
@@ -116,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
@@ -140,9 +142,9 @@ 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.
-      */
+    * @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();
 
     /**
@@ -177,16 +179,25 @@ private:
 
 private slots:
     /**
-      * @brief Set auto centering feature enabled / disabled
-      */
+    * @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();
 
     /**
+    * @brief Slot for display state changed.
+    *
+    * @param enabled true if enabled, false otherwise
+    */
+    void displayStateChanged(bool enabled);
+
+    /**
     * @brief Slot for auto centering enabling.
     *
     * Calls gps to send last known position
@@ -203,6 +214,23 @@ 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 Requests automatic update.
+    *
+    * Makes automatic location update request if user has moved enough.
+    *
+    * @param position geo coordinates
+    */
+    void requestAutomaticUpdateIfMoved(QPointF position);
+
+    /**
      * @brief Sets zoom level to default when first GPS location is received if autocentering
      * is enabled.
      *
@@ -210,18 +238,32 @@ private slots:
      * @param accuracy accuracy of GPS location
      */
     void setFirstStartZoomLevel(QPointF latLonCoordinate, qreal accuracy);
-    
+
     /**
-    * @brief Slot for intercepting signal when credentials are invalid
+    * @brief Automatic update interval timer timeout.
     *
+    * Requests update location if user has moved.
     */
-    void invalidCredentials();
+    void startAutomaticUpdate();
 
 /*******************************************************************************
  * 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
     *
     * @param friendList List of User instances (friends)
@@ -239,14 +281,21 @@ signals:
  * DATA MEMBERS
  ******************************************************************************/
 private:
-    bool m_autoCenteringEnabled;  ///< Auto centering enabled
-    bool m_loggedIn;              ///< Login state
+    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
+
 
     FacebookAuthentication *m_facebookAuthenticator; ///< Instance for facebook authenticator
     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