1 // gps.hxx - distance-measuring equipment.
2 // Written by David Megginson, started 2003.
4 // This file is in the Public Domain and comes with no warranty.
7 #ifndef __INSTRUMENTS_GPS_HXX
8 #define __INSTRUMENTS_GPS_HXX 1
13 #include <simgear/props/props.hxx>
14 #include <simgear/structure/subsystem_mgr.hxx>
15 #include <simgear/props/tiedpropertylist.hxx>
17 #include <Navaids/positioned.hxx>
18 #include <Navaids/FlightPlan.hxx>
19 #include <Instrumentation/rnav_waypt_controller.hxx>
21 #define FG_210_COMPAT 1
28 * /position/longitude-deg
29 * /position/latitude-deg
30 * /position/altitude-ft
31 * /environment/magnetic-variation-deg
32 * /systems/electrical/outputs/gps
33 * /instrumentation/gps/serviceable
38 * /instrumentation/gps/indicated-longitude-deg
39 * /instrumentation/gps/indicated-latitude-deg
40 * /instrumentation/gps/indicated-altitude-ft
41 * /instrumentation/gps/indicated-vertical-speed-fpm
42 * /instrumentation/gps/indicated-track-true-deg
43 * /instrumentation/gps/indicated-track-magnetic-deg
44 * /instrumentation/gps/indicated-ground-speed-kt
46 * /instrumentation/gps/wp-distance-nm
47 * /instrumentation/gps/wp-bearing-deg
48 * /instrumentation/gps/wp-bearing-mag-deg
49 * /instrumentation/gps/TTW
50 * /instrumentation/gps/course-deviation-deg
51 * /instrumentation/gps/course-error-nm
52 * /instrumentation/gps/to-flag
53 * /instrumentation/gps/odometer
54 * /instrumentation/gps/trip-odometer
55 * /instrumentation/gps/true-bug-error-deg
56 * /instrumentation/gps/magnetic-bug-error-deg
58 class GPS : public SGSubsystem,
59 public flightgear::RNAV,
60 public flightgear::FlightPlan::Delegate
63 GPS (SGPropertyNode *node, bool defaultGPSMode = false);
67 // SGSubsystem interface
69 virtual void reinit ();
70 virtual void update (double delta_time_sec);
73 virtual void unbind();
76 virtual SGGeod position();
77 virtual double trackDeg();
78 virtual double groundSpeedKts();
79 virtual double vspeedFPM();
80 virtual double magvarDeg();
81 virtual double selectedMagCourse();
82 virtual double overflightDistanceM();
83 virtual double overflightArmDistanceM();
84 virtual double overflightArmAngleDeg();
85 virtual SGGeod previousLegWaypointPosition(bool& isValid);
88 friend class SearchFilter;
91 * Configuration manager, track data relating to aircraft installation
98 void bind(GPS* aOwner, SGPropertyNode* aCfg);
100 bool turnAnticipationEnabled() const { return _enableTurnAnticipation; }
103 * Desired turn rate in degrees/second. From this we derive the turn
104 * radius and hence how early we need to anticipate it.
106 double turnRateDegSec() const { return _turnRate; }
109 * Distance at which we switch to next waypoint.
111 double overflightDistanceNm() const { return _overflightDistance; }
113 * Distance at which we arm overflight sequencing. Once inside this
114 * distance, a change of the wp1 'TO' flag to false will be considered
115 * overlight of the wp.
117 double overflightArmDistanceNm() const { return _overflightArmDistance; }
119 * abs angle at which we arm overflight sequencing.
121 double overflightArmAngleDeg() const { return _overflightArmAngle; }
124 * Time before the next WP to activate an external annunciator
126 double waypointAlertTime() const { return _waypointAlertTime; }
128 bool requireHardSurface() const { return _requireHardSurface; }
130 bool cdiDeflectionIsAngular() const { return (_cdiMaxDeflectionNm <= 0.0); }
132 double cdiDeflectionLinearPeg() const
134 assert(_cdiMaxDeflectionNm > 0.0);
135 return _cdiMaxDeflectionNm;
138 bool driveAutopilot() const { return _driveAutopilot; }
140 bool courseSelectable() const { return _courseSelectable; }
143 bool _enableTurnAnticipation;
145 // desired turn rate in degrees per second
148 // distance from waypoint to arm overflight sequencing (in nm)
149 double _overflightDistance;
151 // distance from waypoint to arm overflight sequencing (in nm)
152 double _overflightArmDistance;
154 //abs angle from course to waypoint to arm overflight sequencing (in deg)
155 double _overflightArmAngle;
157 // time before reaching a waypoint to trigger annunciator light/sound
159 double _waypointAlertTime;
161 // should we require a hard-surfaced runway when filtering?
162 bool _requireHardSurface;
164 double _cdiMaxDeflectionNm;
166 // should we drive the autopilot directly or not?
167 bool _driveAutopilot;
169 // is selected-course-deg read to set desired-course or not?
170 bool _courseSelectable;
173 class SearchFilter : public FGPositioned::Filter
176 virtual bool pass(FGPositioned* aPos) const;
178 virtual FGPositioned::Type minType() const;
179 virtual FGPositioned::Type maxType() const;
182 /** reset all output properties to default / non-service values */
185 void updateBasicData(double dt);
187 void updateTrackingBug();
188 void updateRouteData();
189 void driveAutopilot();
192 void updateOverflight();
196 double computeTurnProgress(double aBearing) const;
197 void computeTurnData();
198 void updateTurnData();
199 double computeTurnRadiusNm(double aGroundSpeedKts) const;
201 /** Update one-shot things when WP1 / leg data change */
206 /** Predicate, determine if the lon/lat position in the scratch is
208 bool isScratchPositionValid() const;
211 void setScratchFromPositioned(FGPositioned* aPos, int aIndex);
212 void setScratchFromCachedSearchResult();
213 void setScratchFromRouteWaypoint(int aIndex);
215 /** Add airport-specific information to a scratch result */
216 void addAirportToScratch(FGAirport* aAirport);
218 FGPositioned::Filter* createFilter(FGPositioned::Type aTy);
220 /** Search kernel - called each time we step through a result */
221 void performSearch();
224 void loadRouteWaypoint();
228 void previousResult();
229 void defineWaypoint();
230 void insertWaypointAtIndex(int aIndex);
231 void removeWaypointAtIndex(int aIndex);
233 // tied-property getter/setters
234 double getScratchDistance() const;
235 double getScratchMagBearing() const;
236 double getScratchTrueBearing() const;
237 bool getScratchHasNext() const;
242 void selectLegMode();
243 void selectOBSMode(flightgear::Waypt* waypt);
246 // tied-property getter/setters
247 void setCommand(const char* aCmd);
248 const char* getCommand() const { return ""; }
250 const char* getMode() const { return _mode.c_str(); }
251 bool getScratchValid() const { return _scratchValid; }
253 double getSelectedCourse() const { return _selectedCourse; }
254 void setSelectedCourse(double crs);
255 double getDesiredCourse() const { return _desiredCourse; }
257 double getCDIDeflection() const;
259 double getLegDistance() const;
260 double getLegCourse() const;
261 double getLegMagCourse() const;
263 double getTrueTrack() const { return _last_true_track; }
264 double getMagTrack() const;
265 double getGroundspeedKts() const { return _last_speed_kts; }
266 double getVerticalSpeed() const { return _last_vertical_speed; }
268 const char* getWP0Ident() const;
269 const char* getWP0Name() const;
271 bool getWP1IValid() const;
272 const char* getWP1Ident() const;
273 const char* getWP1Name() const;
275 double getWP1Distance() const;
276 double getWP1TTW() const;
277 const char* getWP1TTWString() const;
278 double getWP1Bearing() const;
279 double getWP1MagBearing() const;
280 double getWP1CourseDeviation() const;
281 double getWP1CourseErrorNm() const;
282 bool getWP1ToFlag() const;
283 bool getWP1FromFlag() const;
285 // true-bearing-error and mag-bearing-error
289 * Tied-properties helper, record nodes which are tied for easy un-tie-ing
291 template <typename T>
292 void tie(SGPropertyNode* aNode, const char* aRelPath, const SGRawValue<T>& aRawValue)
294 _tiedProperties.Tie(aNode->getNode(aRelPath, true), aRawValue);
297 /** helper, tie the lat/lon/elev of a SGGeod to the named children of aNode */
298 void tieSGGeod(SGPropertyNode* aNode, SGGeod& aRef,
299 const char* lonStr, const char* latStr, const char* altStr);
301 /** helper, tie a SGGeod to proeprties, but read-only */
302 void tieSGGeodReadOnly(SGPropertyNode* aNode, SGGeod& aRef,
303 const char* lonStr, const char* latStr, const char* altStr);
305 // FlightPlan::Delegate
306 virtual void currentWaypointChanged();
307 virtual void waypointsChanged();
308 virtual void cleared();
309 virtual void endOfFlightPlan();
312 void routeManagerFlightPlanChanged(SGPropertyNode*);
313 void routeActivated(SGPropertyNode*);
316 SGPropertyNode_ptr _gpsNode;
317 SGPropertyNode_ptr _currentWayptNode;
318 SGPropertyNode_ptr _magvar_node;
319 SGPropertyNode_ptr _serviceable_node;
320 SGPropertyNode_ptr _electrical_node;
321 SGPropertyNode_ptr _tracking_bug_node;
322 SGPropertyNode_ptr _raim_node;
324 SGPropertyNode_ptr _odometer_node;
325 SGPropertyNode_ptr _trip_odometer_node;
326 SGPropertyNode_ptr _true_bug_error_node;
327 SGPropertyNode_ptr _magnetic_bug_error_node;
328 SGPropertyNode_ptr _eastWestVelocity;
329 SGPropertyNode_ptr _northSouthVelocity;
331 // SGPropertyNode_ptr _route_active_node;
332 SGPropertyNode_ptr _route_current_wp_node;
333 SGPropertyNode_ptr _routeDistanceNm;
334 SGPropertyNode_ptr _routeETE;
335 SGPropertyNode_ptr _desiredCourseNode;
337 double _selectedCourse;
338 double _desiredCourse;
343 double _last_speed_kts;
344 double _last_true_track;
345 double _last_vertical_speed;
346 double _lastEWVelocity;
347 double _lastNSVelocity;
350 * the instrument manager creates a default instance of us,
351 * if no explicit GPS is specific in the aircraft's instruments.xml file.
352 * This allows default route-following to work with the generic autopilot.
353 * This flat is set in that case, to inform us we're a 'fake' installation,
354 * and not to worry about electrical power or similar.
356 bool _defaultGPSMode;
363 SGGeod _wp0_position;
364 SGGeod _indicated_pos;
365 double _legDistanceNm;
369 SGPropertyNode_ptr _scratchNode;
373 int _searchResultIndex;
374 std::string _searchQuery;
375 FGPositioned::Type _searchType;
377 FGPositionedList _searchResults;
378 bool _searchIsRoute; ///< set if 'search' is actually the current route
379 bool _searchHasNext; ///< is there a result after this one?
380 bool _searchNames; ///< set if we're searching names instead of idents
384 bool _computeTurnData; ///< do we need to update the turn data?
385 bool _anticipateTurn; ///< are we anticipating the next turn or not?
386 bool _inTurn; // is a turn in progress?
387 bool _turnSequenced; // have we sequenced the new leg?
388 double _turnAngle; // angle to turn through, in degrees
389 double _turnStartBearing; // bearing of inbound leg
390 double _turnRadius; // radius of turn in nm
394 std::auto_ptr<flightgear::WayptController> _wayptController;
396 flightgear::WayptRef _prevWaypt;
397 flightgear::WayptRef _currentWaypt;
399 // autopilot drive properties
400 SGPropertyNode_ptr _apDrivingFlag;
401 SGPropertyNode_ptr _apTrueHeading;
403 simgear::TiedPropertyList _tiedProperties;
405 flightgear::FlightPlanRef _route;
407 SGPropertyChangeCallback<GPS> _callbackFlightPlanChanged;
408 SGPropertyChangeCallback<GPS> _callbackRouteActivated;
411 #endif // __INSTRUMENTS_GPS_HXX