1 // dclgps.hxx - a class to extend the operation of FG's current GPS
2 // code, and provide support for a KLN89-specific instrument. It
3 // is envisioned that eventually this file and class will be split
4 // up between current FG code and new KLN89-specific code and removed.
6 // Written by David Luff, started 2005.
8 // Copyright (C) 2005 - David C Luff: daveluff --AT-- ntlworld --D0T-- com
10 // This program is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU General Public License as
12 // published by the Free Software Foundation; either version 2 of the
13 // License, or (at your option) any later version.
15 // This program is distributed in the hope that it will be useful, but
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // General Public License for more details.
20 // You should have received a copy of the GNU General Public License
21 // along with this program; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
29 #include "render_area_2d.hxx"
35 #include <simgear/structure/subsystem_mgr.hxx>
36 #include <Navaids/positioned.hxx>
46 enum GPSDistanceUnits {
47 GPS_DIST_UNITS_NM = 0,
56 enum GPSAltitudeUnits {
61 enum GPSPressureUnits {
62 GPS_PRES_UNITS_IN = 1,
67 // --------------------- Waypoint / Flightplan stuff -----------------------------
68 // This should be merged with other similar stuff in FG at some point.
70 // NOTE - ORDERING IS IMPORTANT HERE - it matches the Bendix-King page ordering!
77 GPS_WP_VIRT // Used for virtual waypoints, such as the start of DTO operation.
81 GPS_IAF, // Initial approach fix
82 GPS_IAP, // Waypoint on approach sequence that isn't any of the others.
83 GPS_FAF, // Final approach fix
84 GPS_MAP, // Missed approach point
85 GPS_MAHP, // Initial missed approach holding point.
86 GPS_HDR, // A virtual 'waypoint' to represent the approach header in the fpl page
87 GPS_FENCE, // A virtual 'waypoint' to represent the NO WPT SEQ fence.
88 GPS_APP_NONE // Not part of the approach sequence - the default.
91 ostream& operator << (ostream& os, GPSAppWpType type);
96 GPSWaypoint(const std::string& aIdent, float lat, float lon, GPSWpType aType);
98 static GPSWaypoint* createFromPositioned(const FGPositioned* aFix);
101 string GetAprId(); // Returns the id with i, f, m or h added if appropriate. (Initial approach fix, final approach fix, etc)
103 float lat; // Radians
104 float lon; // Radians
106 GPSAppWpType appType; // only used for waypoints that are part of an approach sequence
109 typedef vector < GPSWaypoint* > gps_waypoint_array;
110 typedef gps_waypoint_array::iterator gps_waypoint_array_iterator;
111 typedef map < string, gps_waypoint_array > gps_waypoint_map;
112 typedef gps_waypoint_map::iterator gps_waypoint_map_iterator;
113 typedef gps_waypoint_map::const_iterator gps_waypoint_map_const_iterator;
115 class GPSFlightPlan {
117 vector<GPSWaypoint*> waypoints;
118 inline bool IsEmpty() { return(waypoints.size() == 0); }
121 // TODO - probably de-public the internals of the next 2 classes and add some methods!
122 // Instrument approach procedure base class
126 virtual ~FGIAP() = 0;
129 string _id; // The ID of the airport this approach is for
130 string _name; // The approach name, eg "VOR/DME OR GPS-B"
131 string _abbrev; // The abbreviation the GPS unit uses - eg "VOR/D" in this instance. Possibly GPS model specific.
132 string _rwyStr; // The string used to specify the rwy - eg "B" in this instance.
133 bool _precision; // True for precision approach, false for non-precision.
136 // Non-precision instrument approach procedure
137 class FGNPIAP : public FGIAP {
143 vector<GPSWaypoint*> _IAF; // The initial approach fix(es)
144 vector<GPSWaypoint*> _IAP; // The compulsory waypoints of the approach procedure (may duplicate one of the above).
145 // _IAP includes the FAF and MAF.
146 vector<GPSWaypoint*> _MAP; // The missed approach procedure (doesn't include the MAF).
149 typedef vector < FGIAP* > iap_list_type;
150 typedef map < string, iap_list_type > iap_map_type;
151 typedef iap_map_type::iterator iap_map_iterator;
153 // A class to encapsulate hr:min representation of time.
158 ClockTime(int hr, int min);
160 inline void set_hr(int hr) { _hr = hr; }
161 inline int hr() const { return(_hr); }
162 inline void set_min(int min) { _min = min; }
163 inline int min() const { return(_min); }
165 ClockTime operator+ (const ClockTime& t) {
166 int cumMin = _hr * 60 + _min + t.hr() * 60 + t.min();
167 ClockTime t2(cumMin / 60, cumMin % 60);
170 // Operator - has a max difference of 23:59,
171 // and assumes the day has wrapped if the second operand
172 // is larger that the first.
173 // eg. 2:59 - 3:00 = 23:59
174 ClockTime operator- (const ClockTime& t) {
175 int diff = (_hr * 60 + _min) - (t.hr() * 60 + t.min());
176 if(diff < 0) { diff += 24 * 60; }
177 ClockTime t2(diff / 60, diff % 60);
180 friend ostream& operator<< (ostream& out, const ClockTime& t);
187 // ------------------------------------------------------------------------------
189 // TODO - merge generic GPS functions instead and split out KLN specific stuff.
190 class DCLGPS : public SGSubsystem {
193 DCLGPS(RenderArea2D* instrument);
194 virtual ~DCLGPS() = 0;
196 virtual void draw(osg::State& state);
200 virtual void unbind();
201 virtual void update(double dt);
203 // Render string s in display field field at position x, y
204 // WHERE POSITION IS IN CHARACTER UNITS!
206 virtual void DrawText(const string& s, int field, int px, int py, bool bold = false);
208 // Render a char at a given position as above
209 virtual void DrawChar(char c, int field, int px, int py, bool bold = false);
211 virtual void ToggleOBSMode();
213 // Set the number of fields
214 inline void SetNumFields(int n) { _nFields = (n > _maxFields ? _maxFields : (n < 1 ? 1 : n)); }
217 // m if true, ft if false
218 inline void SetAltUnitsSI(bool b) { _altUnits = (b ? GPS_ALT_UNITS_M : GPS_ALT_UNITS_FT); }
219 // Returns true if alt units are SI (m), false if ft
220 inline bool GetAltUnitsSI() { return(_altUnits == GPS_ALT_UNITS_M ? true : false); }
221 // km and k/h if true, nm and kt if false
222 inline void SetDistVelUnitsSI(bool b) { _distUnits = (b ? GPS_DIST_UNITS_KM : GPS_DIST_UNITS_NM); _velUnits = (b ? GPS_VEL_UNITS_KPH : GPS_VEL_UNITS_KT); }
223 // Returns true if dist/vel units are SI
224 inline bool GetDistVelUnitsSI() { return(_distUnits == GPS_DIST_UNITS_KM && _velUnits == GPS_VEL_UNITS_KPH ? true : false); }
225 // Set baro units - 1 = in, 2 = mB, 3 = hP Wrapping if for the convienience of the GPS setter.
226 void SetBaroUnits(int n, bool wrap = false);
227 // Get baro units: 1 = in, 2 = mB, 3 = hP
228 inline int GetBaroUnits() { return((int)_baroUnits); }
230 // It is expected that specific GPS units will override these functions.
231 // Increase the CDI full-scale deflection (ie. increase the nm per dot) one (GPS unit dependent) increment. Wraps if necessary (GPS unit dependent).
232 virtual void CDIFSDIncrease();
233 // Ditto for decrease the distance per dot
234 virtual void CDIFSDDecrease();
237 ////inline void SetOverlays(Overlays* overlays) { _overlays = overlays; }
239 virtual void CreateDefaultFlightPlans();
241 void SetOBSFromWaypoint();
243 GPSWaypoint* GetActiveWaypoint();
244 // Get the (zero-based) position of the active waypoint in the active flightplan
245 // Returns -1 if no active waypoint.
246 int GetActiveWaypointIndex();
247 // Ditto for an arbitrary waypoint id
248 int GetWaypointIndex(const string& id);
251 float GetDistToActiveWaypoint();
252 // Returns degrees (magnetic)
253 float GetHeadingToActiveWaypoint();
254 // Returns degrees (magnetic)
255 float GetHeadingFromActiveWaypoint();
256 // Get the time to the active waypoint in seconds.
257 // Returns -1 if groundspeed < 30 kts
258 double GetTimeToActiveWaypoint();
259 // Get the time to the final waypoint in seconds.
260 // Returns -1 if groundspeed < 30 kts
262 // Get the time to a given waypoint (spec'd by ID) in seconds.
263 // returns -1 if groundspeed is less than 30kts.
264 // If the waypoint is an unreached part of the active flight plan the time will be via each leg.
265 // otherwise it will be a direct-to time.
266 double GetTimeToWaypoint(const string& id);
268 // Return true if waypoint alerting is occuring
269 inline bool GetWaypointAlert() const { return(_waypointAlert); }
270 // Return true if in OBS mode
271 inline bool GetOBSMode() const { return(_obsMode); }
272 // Return true if in Leg mode
273 inline bool GetLegMode() const { return(!_obsMode); }
275 // Clear a flightplan
276 void ClearFlightPlan(int n);
277 void ClearFlightPlan(GPSFlightPlan* fp);
279 // Returns true if an approach is loaded/armed/active in the active flight plan
280 inline bool ApproachLoaded() const { return(_approachLoaded); }
281 inline bool GetApproachArm() const { return(_approachArm); }
282 inline bool GetApproachActive() const { return(_approachActive); }
283 double GetCDIDeflection() const;
284 inline bool GetToFlag() const { return(_headingBugTo); }
286 // Initiate Direct To operation to the supplied ID.
287 void DtoInitiate(const string& id);
288 // Cancel Direct To operation
292 // Maximum number of display fields for this device
294 // Current number of on-screen fields
300 // Lower (y) border per field
301 int _yFieldBorder[4];
302 // Left (x) border per field
303 int _xFieldBorder[4];
304 // Field start in x dir (border is part of field since it is the normal char border - sometimes map mode etc draws in it)
306 // Field start in y dir (for completeness - KLN89 only has vertical divider.
309 // The number of pages on the cyclic knob control
310 unsigned int _nPages;
311 // The current page we're on (Not sure how this ties in with extra pages such as direct or nearest).
312 unsigned int _curPage;
315 RenderArea2D* _instrument;
318 GPSSpeedUnits _velUnits;
319 GPSDistanceUnits _distUnits;
320 GPSPressureUnits _baroUnits;
321 GPSAltitudeUnits _altUnits;
323 // CDI full-scale deflection, specified either as an index into a vector of values (standard values) or as a double precision float (intermediate values).
324 // This will influence how an externally driven CDI will display as well as the NAV1 page.
325 // Hence the variables are located here, not in the nav page class.
326 vector<float> _cdiScales;
327 unsigned int _currentCdiScaleIndex;
328 bool _cdiScaleTransition; // Set true when the floating CDI value is used during transitions
329 double _currentCdiScale; // The floating value to use.
330 unsigned int _targetCdiScaleIndex; // The target indexed value to attain during a transition.
331 unsigned int _sourceCdiScaleIndex; // The source indexed value during a transition - so we know which way we're heading!
332 // Timers to handle the transitions - not sure if we need these.
333 double _apprArmTimer;
334 double _apprActvTimer;
335 double _cdiTransitionTime; // Time for transition to occur in - normally 30sec but may be quicker if time to FAF < 30sec?
338 // Data and lookup functions
342 // Find first of any type of waypoint by id. (TODO - Possibly we should return multiple waypoints here).
343 GPSWaypoint* FindFirstById(const string& id) const;
344 GPSWaypoint* FindFirstByExactId(const string& id) const;
346 FGNavRecord* FindFirstVorById(const string& id, bool &multi, bool exact = false);
347 FGNavRecord* FindFirstNDBById(const string& id, bool &multi, bool exact = false);
348 const FGAirport* FindFirstAptById(const string& id, bool &multi, bool exact = false);
349 const FGFix* FindFirstIntById(const string& id, bool &multi, bool exact = false);
350 // Find the closest VOR to a position in RADIANS.
351 FGNavRecord* FindClosestVor(double lat_rad, double lon_rad);
353 // helper to implement the above FindFirstXXX methods
354 FGPositioned* FindTypedFirstById(const std::string& id, FGPositioned::Type ty, bool &multi, bool exact);
356 // Position, orientation and velocity.
357 // These should be read from FG's built-in GPS logic if possible.
358 // Use the property node pointers below to do this.
359 SGPropertyNode_ptr _lon_node;
360 SGPropertyNode_ptr _lat_node;
361 SGPropertyNode_ptr _alt_node;
362 SGPropertyNode_ptr _grnd_speed_node;
363 SGPropertyNode_ptr _true_track_node;
364 SGPropertyNode_ptr _mag_track_node;
365 // Present position. (Radians)
367 // Present altitude (ft). (Yuk! but it saves converting ft->m->ft every update).
369 // Reported position as measured by GPS. For now this is the same
370 // as present position, but in the future we might want to model
371 // GPS lat and lon errors.
372 // Note - we can depriciate _gpsLat and _gpsLon if we implement error handling in FG
373 // gps code and not our own.
374 double _gpsLat, _gpsLon; //(Radians)
375 // Hack - it seems that the GPS gets initialised before FG's initial position is properly set.
376 // By checking for abnormal slew in the position we can force a re-initialisation of active flight
377 // plan leg and anything else that might be affected.
378 // TODO - sort FlightGear's initialisation order properly!!!
379 double _checkLat, _checkLon; // (Radians)
380 double _groundSpeed_ms; // filtered groundspeed (m/s)
381 double _groundSpeed_kts; // ditto in knots
382 double _track; // filtered true track (degrees)
383 double _magTrackDeg; // magnetic track in degrees calculated from true track above
385 // _navFlagged is set true when GPS navigation is either not possible or not logical.
386 // This includes not receiving adequate signals, and not having an active flightplan entered.
389 // Positional functions copied from ATCutils that might get replaced
390 // INPUT in RADIANS, returns DEGREES!
392 double GetMagHeadingFromTo(double latA, double lonA, double latB, double lonB);
394 //double GetHeadingFromTo(double latA, double lonA, double latB, double lonB);
396 // Given two positions (lat & lon in RADIANS), get the HORIZONTAL separation (in meters)
397 //double GetHorizontalSeparation(double lat1, double lon1, double lat2, double lon2);
399 // Proper great circle positional functions from The Aviation Formulary
400 // Returns distance in Nm, input in RADIANS.
401 double GetGreatCircleDistance(double lat1, double lon1, double lat2, double lon2) const;
403 // Input in RADIANS, output in DEGREES.
405 double GetGreatCircleCourse(double lat1, double lon1, double lat2, double lon2) const;
407 // Return a position on a radial from wp1 given distance d (nm) and magnetic heading h (degrees)
408 // Note that d should be less that 1/4 Earth diameter!
409 GPSWaypoint GetPositionOnMagRadial(const GPSWaypoint& wp1, double d, double h);
411 // Return a position on a radial from wp1 given distance d (nm) and TRUE heading h (degrees)
412 // Note that d should be less that 1/4 Earth diameter!
413 GPSWaypoint GetPositionOnRadial(const GPSWaypoint& wp1, double d, double h);
415 // Calculate the current cross-track deviation in nm.
416 // Returns zero if a sensible value cannot be calculated.
417 double CalcCrossTrackDeviation() const;
419 // Calculate the cross-track deviation between 2 arbitrary waypoints in nm.
420 // Returns zero if a sensible value cannot be calculated.
421 double CalcCrossTrackDeviation(const GPSWaypoint& wp1, const GPSWaypoint& wp2) const;
424 // GPS can have up to _maxFlightPlans flightplans stored, PLUS an active FP which may or my not be one of the stored ones.
425 // This is from KLN89, but is probably not far off the mark for most if not all GPS.
426 vector<GPSFlightPlan*> _flightPlans;
427 unsigned int _maxFlightPlans;
428 GPSFlightPlan* _activeFP;
430 // Modes of operation.
431 // This is currently somewhat Bendix-King specific, but probably applies fundamentally to other units as well
432 // Mode defaults to leg, but is OBS if _obsMode is true.
434 // _dto is set true for DTO operation
436 // In leg mode, we need to know if we are displaying a from and to waypoint, or just the to waypoint (eg. when OBS mode is cancelled).
438 // In OBS mode we need to know the set OBS heading
441 // Operational variables
442 GPSWaypoint _activeWaypoint;
443 GPSWaypoint _fromWaypoint;
445 float _crosstrackDist; // UNITS ??????????
446 double _eta; // ETA in SECONDS to active waypoint.
447 // Desired track for active leg, true and magnetic, in degrees
448 double _dtkTrue, _dtkMag;
449 bool _headingBugTo; // Set true when the heading bug is TO, false when FROM.
450 bool _waypointAlert; // Set true when waypoint alerting is happening. (This is a variable NOT a user-setting).
451 bool _departed; // Set when groundspeed first exceeds 30kts.
452 string _departureTimeString; // Ditto.
453 double _elapsedTime; // Elapsed time in seconds since departure
454 ClockTime _powerOnTime; // Time (hr:min) of unit power-up.
455 bool _powerOnTimerSet; // Indicates that we have set the above following power-up.
456 void SetPowerOnTimer();
458 void ResetPowerOnTimer();
459 // Set the alarm to go off at a given time.
460 inline void SetAlarm(int hr, int min) {
461 _alarmTime.set_hr(hr);
462 _alarmTime.set_min(min);
466 ClockTime _alarmTime;
469 // Configuration that affects flightplan operation
470 bool _turnAnticipationEnabled;
472 // Configuration that affects general operation
473 bool _suaAlertEnabled; // Alert user to potential SUA entry
474 bool _altAlertEnabled; // Alert user to min safe alt violation
476 // Magvar stuff. Might get some of this stuff (such as time) from FG in future.
479 list<string> _messageStack;
481 virtual void CreateFlightPlan(GPSFlightPlan* fp, vector<string> ids, vector<GPSWpType> wps);
483 // Orientate the GPS unit to a flightplan - ie. figure out from current position
484 // and possibly orientation which leg of the FP we are on.
485 virtual void OrientateToFlightPlan(GPSFlightPlan* fp);
487 // Ditto for active fp. Probably all we need really!
488 virtual void OrientateToActiveFlightPlan();
490 int _cleanUpPage; // -1 => no cleanup required.
493 iap_map_type _np_iap; // Non-precision approaches
494 iap_map_type _pr_iap; // Precision approaches
495 bool _approachLoaded; // Set true when an approach is loaded in the active flightplan
496 bool _approachArm; // Set true when in approach-arm mode
497 bool _approachReallyArmed; // Apparently, approach-arm mode can be set from an external GPS-APR switch outside 30nm from airport,
498 // but the CDI scale change doesn't happen until 30nm from airport. Bizarre that it can be armed without
499 // the scale change, but it's in the manual...
500 bool _approachActive; // Set true when in approach-active mode
501 GPSFlightPlan* _approachFP; // Current approach - not necessarily loaded.
502 string _approachID; // ID of the airport we have an approach loaded for - bit of a hack that can hopefully be removed in future.
503 // More hackery since we aren't actually storing an approach class... Doh!
504 string _approachAbbrev;
505 string _approachRwyStr;
508 #endif // _DCLGPS_HXX