Merge branch 'maint2' into next

[flightgear.git] / src / Instrumentation / dclgps.hxx

diff --git a/src/Instrumentation/dclgps.hxx b/src/Instrumentation/dclgps.hxx
index 3dce50401015ac2ff8e5ca49c147fdb191f7a888..435f7899a25e51f53e5ca4ed2a229a8eee3bcfac 100644 (file)
--- a/src/Instrumentation/dclgps.hxx
+++ b/src/Instrumentation/dclgps.hxx
@@ -5,7 +5,7 @@
 //
 // Written by David Luff, started 2005.
 //
-// Copyright (C) 2005 - David C Luff - david.luff@nottingham.ac.uk
+// Copyright (C) 2005 - David C Luff:  daveluff --AT-- ntlworld --D0T-- com
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -19,7 +19,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
@@ -32,13 +32,16 @@
 #include <vector>
 #include <map>
 
-#include <Navaids/navrecord.hxx>
-#include <Navaids/navlist.hxx>
-#include <Navaids/fixlist.hxx>
-#include <Airports/simple.hxx>
 #include <simgear/structure/subsystem_mgr.hxx>
+#include <Navaids/positioned.hxx>
 
-using namespace std;
+class SGTime;
+class FGPositioned;
+
+// XXX fix me
+class FGNavRecord;
+class FGAirport;
+class FGFix;
 
 enum GPSDistanceUnits {
        GPS_DIST_UNITS_NM = 0,
@@ -89,6 +92,11 @@ ostream& operator << (ostream& os, GPSAppWpType type);
 
 struct GPSWaypoint {
     GPSWaypoint();
+  
+  GPSWaypoint(const std::string& aIdent, float lat, float lon, GPSWpType aType);
+  
+  static GPSWaypoint* createFromPositioned(const FGPositioned* aFix);
+  
     ~GPSWaypoint();
        string GetAprId();      // Returns the id with i, f, m or h added if appropriate. (Initial approach fix, final approach fix, etc)
        string id;
@@ -142,6 +150,40 @@ typedef vector < FGIAP* > iap_list_type;
 typedef map < string, iap_list_type > iap_map_type;
 typedef iap_map_type::iterator iap_map_iterator;
 
+//     A class to encapsulate hr:min representation of time. 
+
+class ClockTime {
+public:
+    ClockTime();
+    ClockTime(int hr, int min);
+    ~ClockTime();
+    inline void set_hr(int hr) { _hr = hr; }
+    inline int hr() const { return(_hr); } 
+    inline void set_min(int min) { _min = min; }
+    inline int min() const { return(_min); }
+    
+    ClockTime operator+ (const ClockTime& t) {
+        int cumMin = _hr * 60 + _min + t.hr() * 60 + t.min();
+        ClockTime t2(cumMin / 60, cumMin % 60);
+        return(t2);
+    }
+    // Operator - has a max difference of 23:59,
+    // and assumes the day has wrapped if the second operand
+    // is larger that the first.
+    // eg. 2:59 - 3:00 = 23:59
+    ClockTime operator- (const ClockTime& t) {
+        int diff = (_hr * 60 + _min) - (t.hr() * 60 + t.min());
+        if(diff < 0) { diff += 24 * 60; }
+        ClockTime t2(diff / 60, diff % 60);
+        return(t2);
+    }
+    friend ostream& operator<< (ostream& out, const ClockTime& t);
+
+private:
+    int _hr;
+    int _min;
+};
+
 // ------------------------------------------------------------------------------
 
 class DCLGPS;
@@ -172,7 +214,7 @@ public:
        virtual void CleanUp();
        
        // The LooseFocus function is called when a page or subpage looses focus
-       // and allow pages to clean up state that is maintained whilst focus is
+       // and allows pages to clean up state that is maintained whilst focus is
        // retained, but lost on return.
        virtual void LooseFocus();
        
@@ -371,14 +413,13 @@ protected:
        // 
        
        // Data and lookup functions
-       // All waypoints mapped by id.
-       gps_waypoint_map _waypoints;
-private:
-       // Worker function for the below.
-       const GPSWaypoint* ActualFindFirstById(const string& id, bool exact = false);
+
+
 protected:
        // Find first of any type of waypoint by id.  (TODO - Possibly we should return multiple waypoints here).
-       const GPSWaypoint* FindFirstById(const string& id, bool &multi, bool exact = false); 
+  GPSWaypoint* FindFirstById(const string& id) const;
+  GPSWaypoint* FindFirstByExactId(const string& id) const;
+   
        FGNavRecord* FindFirstVorById(const string& id, bool &multi, bool exact = false);
        FGNavRecord* FindFirstNDBById(const string& id, bool &multi, bool exact = false);
        const FGAirport* FindFirstAptById(const string& id, bool &multi, bool exact = false);
@@ -386,6 +427,9 @@ protected:
        // Find the closest VOR to a position in RADIANS.
        FGNavRecord* FindClosestVor(double lat_rad, double lon_rad);
 
+  // helper to implement the above FindFirstXXX methods
+  FGPositioned* FindTypedFirstById(const std::string& id, FGPositioned::Type ty, bool &multi, bool exact);
+
        // Position, orientation and velocity.
        // These should be read from FG's built-in GPS logic if possible.
        // Use the property node pointers below to do this.
@@ -484,6 +528,20 @@ protected:
        bool _departed;         // Set when groundspeed first exceeds 30kts.
        string _departureTimeString;    // Ditto.
        double _elapsedTime;    // Elapsed time in seconds since departure
+       ClockTime _powerOnTime;         // Time (hr:min) of unit power-up.
+       bool _powerOnTimerSet;          // Indicates that we have set the above following power-up.
+       void SetPowerOnTimer();
+public:
+       void ResetPowerOnTimer();
+       // Set the alarm to go off at a given time.
+       inline void SetAlarm(int hr, int min) {
+               _alarmTime.set_hr(hr);
+               _alarmTime.set_min(min);
+               _alarmSet = true;
+       }
+protected:
+       ClockTime _alarmTime;
+       bool _alarmSet;
        
        // Configuration that affects flightplan operation
        bool _turnAnticipationEnabled;