1 // newauto.hxx -- autopilot defines and prototypes (very alpha)
3 // Started April 1998 Copyright (C) 1998
5 // Contributions by Jeff Goeke-Smith <jgoeke@voyager.net>
6 // Norman Vine <nhv@cape.com>
7 // Curtis Olson <curt@flightgear.org>
9 // This program is free software; you can redistribute it and/or
10 // modify it under the terms of the GNU General Public License as
11 // published by the Free Software Foundation; either version 2 of the
12 // License, or (at your option) any later version.
14 // This program is distributed in the hope that it will be useful, but
15 // WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 // General Public License for more details.
19 // You should have received a copy of the GNU General Public License
20 // along with this program; if not, write to the Free Software
21 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 #include <simgear/misc/props.hxx>
31 #include <simgear/route/waypoint.hxx>
33 #include <Main/fg_props.hxx>
40 enum fgAutoHeadingMode {
41 FG_DG_HEADING_LOCK = 0, // follow bug on directional gryo
42 FG_TC_HEADING_LOCK = 1, // keep turn coordinator zero'd
43 FG_TRUE_HEADING_LOCK = 2, // lock to true heading (i.e. a perfect world)
44 FG_HEADING_NAV1 = 3, // follow nav1 radial
45 FG_HEADING_NAV2 = 4, // follow nav2 radial
46 FG_HEADING_WAYPOINT = 5 // track next waypoint
49 enum fgAutoAltitudeMode {
50 FG_ALTITUDE_LOCK = 0, // lock to a specific altitude
51 FG_ALTITUDE_TERRAIN = 1, // try to maintain a specific AGL
52 FG_ALTITUDE_GS1 = 2, // follow glide slope 1
53 FG_ALTITUDE_GS2 = 3 // follow glide slope 2
58 bool heading_hold; // the current state of the heading hold
59 bool altitude_hold; // the current state of the altitude hold
60 bool auto_throttle; // the current state of the auto throttle
62 fgAutoHeadingMode heading_mode;
63 fgAutoAltitudeMode altitude_mode;
65 SGWayPoint waypoint; // the waypoint the AP should steer to.
67 // double TargetLatitude; // the latitude the AP should steer to.
68 // double TargetLongitude; // the longitude the AP should steer to.
69 double TargetDistance; // the distance to Target.
70 double DGTargetHeading; // the apparent DG heading to steer towards.
71 double TargetHeading; // the true heading the AP should steer to.
72 double TargetAltitude; // altitude to hold
73 double TargetAGL; // the terrain separation
74 SGPropertyNode *min_climb; // minimum climb speed
75 SGPropertyNode *best_climb; // best climb speed
76 SGPropertyNode *elevator_adj_factor; // factor to optimize altitude hold adjustments
77 SGPropertyNode *integral_contrib; // amount of contribution of the integral
78 // component of the pid
79 SGPropertyNode *TargetClimbRate; // target climb rate
80 SGPropertyNode *TargetDescentRate; // target decent rate
81 double TargetSpeed; // speed to shoot for
82 double alt_error_accum; // altitude error accumulator
83 double climb_error_accum; // climb error accumulator (for GS)
84 double speed_error_accum; // speed error accumulator
86 double TargetSlope; // the glide slope hold value
88 double MaxRoll ; // the max the plane can roll for the turn
89 double RollOut; // when the plane should roll out
90 // measured from Heading
91 double MaxAileron; // how far to move the aleroin from center
92 double RollOutSmooth; // deg to use for smoothing Aileron Control
93 double MaxElevator; // the maximum elevator allowed
94 double SlopeSmooth; // smoothing angle for elevator
96 // following for testing disengagement of autopilot upon pilot
97 // interaction with controls
100 double old_elevator_trim;
103 // manual controls override beyond this value
104 double disengage_threshold;
106 // For future cross track error adjust
110 // keeping these locally to save work inside main loop
111 char TargetLatitudeStr[64];
112 char TargetLongitudeStr[64];
113 char TargetLatLonStr[64];
114 char TargetWP1Str[64];
115 char TargetWP2Str[64];
116 char TargetWP3Str[64];
117 char TargetHeadingStr[64];
118 char TargetAltitudeStr[64];
120 SGPropertyNode *latitude_node;
121 SGPropertyNode *longitude_node;
122 SGPropertyNode *altitude_node;
123 SGPropertyNode *altitude_agl_node;
124 SGPropertyNode *vertical_speed_node;
125 SGPropertyNode *heading_node;
126 SGPropertyNode *roll_node;
136 // Initialize autopilot system
139 // Reset the autopilot system
142 // run an interation of the autopilot (updates control positions)
145 void AltitudeSet( double new_altitude );
146 void AltitudeAdjust( double inc );
147 void HeadingAdjust( double inc );
148 void AutoThrottleAdjust( double inc );
150 void HeadingSet( double value );
152 inline bool get_HeadingEnabled() const { return heading_hold; }
153 inline void set_HeadingEnabled( bool value ) { heading_hold = value; }
154 inline fgAutoHeadingMode get_HeadingMode() const { return heading_mode; }
155 void set_HeadingMode( fgAutoHeadingMode mode );
157 inline bool get_AltitudeEnabled() const { return altitude_hold; }
158 inline void set_AltitudeEnabled( bool value ) { altitude_hold = value; }
159 inline fgAutoAltitudeMode get_AltitudeMode() const { return altitude_mode;}
160 void set_AltitudeMode( fgAutoAltitudeMode mode );
162 inline bool get_AutoThrottleEnabled() const { return auto_throttle; }
163 void set_AutoThrottleEnabled( bool value );
165 /* inline void set_WayPoint( const double lon, const double lat,
166 const double alt, const string s ) {
167 waypoint = SGWayPoint( lon, lat, alt, SGWayPoint::WGS84, "Current WP" );
169 inline double get_TargetLatitude() const {
170 return waypoint.get_target_lat();
172 inline double get_TargetLongitude() const {
173 return waypoint.get_target_lon();
175 inline void set_old_lat( double val ) { old_lat = val; }
176 inline void set_old_lon( double val ) { old_lon = val; }
177 inline double get_TargetHeading() const { return TargetHeading; }
178 inline void set_TargetHeading( double val ) { TargetHeading = val; }
179 inline double get_DGTargetHeading() const { return DGTargetHeading; }
180 inline void set_DGTargetHeading( double val ) { DGTargetHeading = val; }
181 inline double get_TargetDistance() const { return TargetDistance; }
182 inline void set_TargetDistance( double val ) { TargetDistance = val; }
183 inline double get_TargetAltitude() const { return TargetAltitude; }
184 inline void set_TargetAltitude( double val ) { TargetAltitude = val; }
185 inline double get_TargetAGL() const { return TargetAGL; }
186 inline void set_TargetAGL( double val ) { TargetAGL = val; }
187 inline double get_TargetClimbRate() const {
188 return TargetClimbRate->getFloatValue();
190 inline void set_TargetClimbRate( double val ) {
191 fgSetFloat( "/autopilot/config/target-climb-rate-fpm", val);
194 inline char *get_TargetLatitudeStr() { return TargetLatitudeStr; }
195 inline char *get_TargetLongitudeStr() { return TargetLongitudeStr; }
196 inline char *get_TargetWP1Str() { return TargetWP1Str; }
197 inline char *get_TargetWP2Str() { return TargetWP2Str; }
198 inline char *get_TargetWP3Str() { return TargetWP3Str; }
199 inline char *get_TargetHeadingStr() { return TargetHeadingStr; }
200 inline char *get_TargetAltitudeStr() { return TargetAltitudeStr; }
201 inline char *get_TargetLatLonStr() { return TargetLatLonStr; }
204 void MakeTargetLatLonStr( double lat, double lon );
205 void MakeTargetAltitudeStr( double altitude );
206 void MakeTargetHeadingStr( double bearing );
207 void MakeTargetWPStr( double distance );
208 void update_old_control_values();
211 inline double get_MaxRoll() const { return MaxRoll; }
212 inline void set_MaxRoll( double val ) { MaxRoll = val; }
213 inline double get_RollOut() const { return RollOut; }
214 inline void set_RollOut( double val ) { RollOut = val; }
216 inline double get_MaxAileron() const { return MaxAileron; }
217 inline void set_MaxAileron( double val ) { MaxAileron = val; }
218 inline double get_RollOutSmooth() const { return RollOutSmooth; }
219 inline void set_RollOutSmooth( double val ) { RollOutSmooth = val; }
224 extern FGAutopilot *current_autopilot;
226 #define DEFAULT_AP_HEADING_LOCK FGAutopilot::FG_DG_HEADING_LOCK
227 // #define DEFAULT_AP_HEADING_LOCK FGAutopilot::FG_TRUE_HEADING_LOCK
229 #endif // _NEWAUTO_HXX