src/Autopilot/route_mgr.cxx

   1 // route_mgr.cxx - manage a route (i.e. a collection of waypoints)
   2 //
   3 // Written by Curtis Olson, started January 2004.
   4 //            Norman Vine
   5 //            Melchior FRANZ
   6 //
   7 // Copyright (C) 2004  Curtis L. Olson  - http://www.flightgear.org/~curt
   8 //
   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.
  13 //
  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.
  18 //
  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  22 //
  23 // $Id$
  24
  25
  26 #ifdef HAVE_CONFIG_H
  27 #  include <config.h>
  28 #endif
  29
  30 #include <simgear/compiler.h>
  31
  32 #include <Airports/simple.hxx>
  33 #include <FDM/flight.hxx>
  34 #include <Main/fg_props.hxx>
  35 #include <Navaids/fixlist.hxx>
  36 #include <Navaids/navlist.hxx>
  37
  38 #include "route_mgr.hxx"
  39
  40 #define RM "/autopilot/route-manager/"
  41
  42
  43 FGRouteMgr::FGRouteMgr() :
  44     route( new SGRoute ),
  45     lon( NULL ),
  46     lat( NULL ),
  47     alt( NULL ),
  48     true_hdg_deg( NULL ),
  49     target_altitude_ft( NULL ),
  50     altitude_lock( NULL ),
  51     wp0_id( NULL ),
  52     wp0_dist( NULL ),
  53     wp0_eta( NULL ),
  54     wp1_id( NULL ),
  55     wp1_dist( NULL ),
  56     wp1_eta( NULL ),
  57     wpn_id( NULL ),
  58     wpn_dist( NULL ),
  59     wpn_eta( NULL ),
  60     input(fgGetNode( RM "input", true )),
  61     listener(new Listener(this)),
  62     mirror(fgGetNode( RM "route", true )),
  63     altitude_set( false )
  64 {
  65     input->setStringValue("");
  66     input->addChangeListener(listener);
  67 }
  68
  69
  70 FGRouteMgr::~FGRouteMgr() {
  71     delete route;
  72     input->removeChangeListener(listener);
  73 }
  74
  75
  76 void FGRouteMgr::init() {
  77     lon = fgGetNode( "/position/longitude-deg", true );
  78     lat = fgGetNode( "/position/latitude-deg", true );
  79     alt = fgGetNode( "/position/altitude-ft", true );
  80
  81     true_hdg_deg = fgGetNode( "/autopilot/settings/true-heading-deg", true );
  82     target_altitude_ft = fgGetNode( "/autopilot/settings/target-altitude-ft", true );
  83     altitude_lock = fgGetNode( "/autopilot/locks/altitude", true );
  84
  85     wp0_id = fgGetNode( RM "wp[0]/id", true );
  86     wp0_dist = fgGetNode( RM "wp[0]/dist", true );
  87     wp0_eta = fgGetNode( RM "wp[0]/eta", true );
  88
  89     wp1_id = fgGetNode( RM "wp[1]/id", true );
  90     wp1_dist = fgGetNode( RM "wp[1]/dist", true );
  91     wp1_eta = fgGetNode( RM "wp[1]/eta", true );
  92
  93     wpn_id = fgGetNode( RM "wp-last/id", true );
  94     wpn_dist = fgGetNode( RM "wp-last/dist", true );
  95     wpn_eta = fgGetNode( RM "wp-last/eta", true );
  96
  97     route->clear();
  98     update_mirror();
  99 }
 100
 101
 102 void FGRouteMgr::postinit() {
 103     string_list *waypoints = globals->get_initial_waypoints();
 104     if (!waypoints)
 105         return;
 106
 107     vector<string>::iterator it;
 108     for (it = waypoints->begin(); it != waypoints->end(); ++it)
 109         new_waypoint(*it);
 110 }
 111
 112
 113 void FGRouteMgr::bind() { }
 114 void FGRouteMgr::unbind() { }
 115
 116
 117 static double get_ground_speed() {
 118     // starts in ft/s so we convert to kts
 119     static const SGPropertyNode * speedup_node = fgGetNode("/sim/speed-up");
 120
 121     double ft_s = cur_fdm_state->get_V_ground_speed()
 122         * speedup_node->getIntValue();
 123     double kts = ft_s * SG_FEET_TO_METER * 3600 * SG_METER_TO_NM;
 124
 125     return kts;
 126 }
 127
 128
 129 void FGRouteMgr::update( double dt ) {
 130     double accum = 0.0;
 131     double wp_course, wp_distance;
 132     char eta_str[128];
 133
 134     // first way point
 135     if ( route->size() > 0 ) {
 136         SGWayPoint wp = route->get_waypoint( 0 );
 137         wp.CourseAndDistance( lon->getDoubleValue(), lat->getDoubleValue(),
 138                               alt->getDoubleValue(), &wp_course, &wp_distance );
 139
 140         true_hdg_deg->setDoubleValue( wp_course );
 141         double target_alt = wp.get_target_alt();
 142
 143         if (!altitude_set && target_alt > -9990) {
 144             target_altitude_ft->setDoubleValue( target_alt * SG_METER_TO_FEET );
 145             altitude_lock->setStringValue( "altitude-hold" );
 146             altitude_set = true;
 147         }
 148
 149         if ( wp_distance < 200.0 ) {
 150             pop_waypoint();
 151             altitude_set = false;
 152         }
 153     }
 154
 155     // next way point
 156     if ( route->size() > 0 ) {
 157         SGWayPoint wp = route->get_waypoint( 0 );
 158         // update the property tree info
 159
 160         wp0_id->setStringValue( wp.get_id().c_str() );
 161
 162         accum += wp_distance;
 163         wp0_dist->setDoubleValue( accum * SG_METER_TO_NM );
 164
 165         double eta = accum * SG_METER_TO_NM / get_ground_speed();
 166         if ( eta >= 100.0 ) { eta = 99.999; }
 167         int major, minor;
 168         if ( eta < (1.0/6.0) ) {
 169             // within 10 minutes, bump up to min/secs
 170             eta *= 60.0;
 171         }
 172         major = (int)eta;
 173         minor = (int)((eta - (int)eta) * 60.0);
 174         snprintf( eta_str, 128, "%d:%02d", major, minor );
 175         wp0_eta->setStringValue( eta_str );
 176     }
 177
 178     // next way point
 179     if ( route->size() > 1 ) {
 180         SGWayPoint wp = route->get_waypoint( 1 );
 181
 182         // update the property tree info
 183
 184         wp1_id->setStringValue( wp.get_id().c_str() );
 185
 186         accum += wp.get_distance();
 187         wp1_dist->setDoubleValue( accum * SG_METER_TO_NM );
 188
 189         double eta = accum * SG_METER_TO_NM / get_ground_speed();
 190         if ( eta >= 100.0 ) { eta = 99.999; }
 191         int major, minor;
 192         if ( eta < (1.0/6.0) ) {
 193             // within 10 minutes, bump up to min/secs
 194             eta *= 60.0;
 195         }
 196         major = (int)eta;
 197         minor = (int)((eta - (int)eta) * 60.0);
 198         snprintf( eta_str, 128, "%d:%02d", major, minor );
 199         wp1_eta->setStringValue( eta_str );
 200     }
 201
 202     // summarize remaining way points
 203     if ( route->size() > 2 ) {
 204         SGWayPoint wp;
 205         for ( int i = 2; i < route->size(); ++i ) {
 206             wp = route->get_waypoint( i );
 207             accum += wp.get_distance();
 208         }
 209
 210         // update the property tree info
 211
 212         wpn_id->setStringValue( wp.get_id().c_str() );
 213
 214         wpn_dist->setDoubleValue( accum * SG_METER_TO_NM );
 215
 216         double eta = accum * SG_METER_TO_NM / get_ground_speed();
 217         if ( eta >= 100.0 ) { eta = 99.999; }
 218         int major, minor;
 219         if ( eta < (1.0/6.0) ) {
 220             // within 10 minutes, bump up to min/secs
 221             eta *= 60.0;
 222         }
 223         major = (int)eta;
 224         minor = (int)((eta - (int)eta) * 60.0);
 225         snprintf( eta_str, 128, "%d:%02d", major, minor );
 226         wpn_eta->setStringValue( eta_str );
 227     }
 228 }
 229
 230
 231 void FGRouteMgr::add_waypoint( const SGWayPoint& wp, int n ) {
 232     route->add_waypoint( wp, n );
 233     update_mirror();
 234 }
 235
 236
 237 SGWayPoint FGRouteMgr::pop_waypoint( int n ) {
 238     SGWayPoint wp;
 239
 240     if ( route->size() > 0 ) {
 241         if ( n < 0 )
 242             n = route->size() - 1;
 243         wp = route->get_waypoint(n);
 244         route->delete_waypoint(n);
 245     }
 246
 247     if ( route->size() <= 2 ) {
 248         wpn_id->setStringValue( "" );
 249         wpn_dist->setDoubleValue( 0.0 );
 250         wpn_eta->setStringValue( "" );
 251     }
 252
 253     if ( route->size() <= 1 ) {
 254         wp1_id->setStringValue( "" );
 255         wp1_dist->setDoubleValue( 0.0 );
 256         wp1_eta->setStringValue( "" );
 257     }
 258
 259     if ( route->size() <= 0 ) {
 260         wp0_id->setStringValue( "" );
 261         wp0_dist->setDoubleValue( 0.0 );
 262         wp0_eta->setStringValue( "" );
 263     }
 264
 265     update_mirror();
 266     return wp;
 267 }
 268
 269
 270 bool FGRouteMgr::build() {
 271     return true;
 272 }
 273
 274
 275
 276 int FGRouteMgr::new_waypoint( const string& Tgt_Alt, int n ) {
 277     string target = Tgt_Alt;
 278
 279     // make upper case
 280     for (unsigned int i = 0; i < target.size(); i++)
 281         if (target[i] >= 'a' && target[i] <= 'z')
 282             target[i] -= 'a' - 'A';
 283
 284     SGWayPoint *wp = 0;
 285     int type = make_waypoint( &wp, target );
 286
 287     if (wp) {
 288         fgSetString( "/autopilot/locks/heading", "true-heading-hold" );
 289         add_waypoint( *wp, n );
 290         delete wp;
 291     }
 292     return type;
 293 }
 294
 295
 296
 297 int FGRouteMgr::make_waypoint(SGWayPoint **wp, string& target) {
 298     double alt = -9999.0;
 299
 300     // extract altitude
 301     unsigned int pos = target.find( '@' );
 302     if ( pos != string::npos ) {
 303         alt = atof( target.c_str() + pos + 1 );
 304         target = target.substr( 0, pos );
 305         if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
 306             alt *= SG_FEET_TO_METER;
 307     }
 308
 309     // check for lon,lat
 310     pos = target.find(',');
 311     if ( pos != string::npos ) {
 312         double lon = atof( target.substr(0, pos).c_str());
 313         double lat = atof( target.c_str() + pos + 1);
 314
 315         SG_LOG( SG_GENERAL, SG_INFO, "Adding waypoint lon = " << lon << ", lat = " << lat );
 316         *wp = new SGWayPoint( lon, lat, alt, SGWayPoint::WGS84, target );
 317         return 1;
 318     }
 319
 320     // check for airport id
 321     const FGAirport *apt = fgFindAirportID( target );
 322     if (apt) {
 323         SG_LOG( SG_GENERAL, SG_INFO, "Adding waypoint (airport) = " << target );
 324         *wp = new SGWayPoint( apt->getLongitude(), apt->getLatitude(), alt, SGWayPoint::WGS84, target );
 325         return 2;
 326     }
 327
 328     // check for fix id
 329     FGFix f;
 330     if ( globals->get_fixlist()->query( target, &f ) ) {
 331         SG_LOG( SG_GENERAL, SG_INFO, "Adding waypoint (fix) = " << target );
 332         *wp = new SGWayPoint( f.get_lon(), f.get_lat(), alt, SGWayPoint::WGS84, target );
 333         return 3;
 334     }
 335
 336     // Try finding a nav matching the ID
 337     double lat, lon;
 338     // The base lon/lat are determined by the last WP,
 339     // or the current pos if the WP list is empty.
 340     const int wps = this->size();
 341
 342     if (wps > 0) {
 343         SGWayPoint wp = get_waypoint(wps-1);
 344         lat = wp.get_target_lat();
 345         lon = wp.get_target_lon();
 346     } else {
 347         lat = fgGetNode("/position/latitude-deg")->getDoubleValue();
 348         lon = fgGetNode("/position/longitude-deg")->getDoubleValue();
 349     }
 350
 351     lat *= SGD_DEGREES_TO_RADIANS;
 352     lon *= SGD_DEGREES_TO_RADIANS;
 353
 354     SG_LOG( SG_GENERAL, SG_INFO, "Looking for nav " << target << " at " << lon << " " << lat);
 355
 356     if (FGNavRecord* nav = globals->get_navlist()->findByIdent(target.c_str(), lon, lat)) {
 357         SG_LOG( SG_GENERAL, SG_INFO, "Adding waypoint (nav) = " << target );
 358         *wp = new SGWayPoint( nav->get_lon(), nav->get_lat(), alt, SGWayPoint::WGS84, target );
 359         return 4;
 360     }
 361
 362     // target not identified
 363     return 0;
 364 }
 365
 366
 367 // mirror internal route to the property system for inspection by other subsystems
 368 void FGRouteMgr::update_mirror() {
 369     mirror->removeChildren("wp");
 370     for (int i = 0; i < route->size(); i++) {
 371         SGWayPoint wp = route->get_waypoint(i);
 372         SGPropertyNode *prop = mirror->getChild("wp", i, 1);
 373
 374         prop->setStringValue("id", wp.get_id().c_str());
 375         prop->setStringValue("name", wp.get_name().c_str());
 376         prop->setDoubleValue("longitude-deg", wp.get_target_lon());
 377         prop->setDoubleValue("latitude-deg", wp.get_target_lat());
 378         prop->setDoubleValue("altitude-m", wp.get_target_alt());
 379         prop->setDoubleValue("altitude-ft", wp.get_target_alt() * SG_METER_TO_FEET);
 380     }
 381     // set number as listener attachment point
 382     mirror->setIntValue("num", route->size());
 383 }
 384
 385
 386 // command interface /autopilot/route-manager/input:
 387 //
 388 //   @clear             ... clear route
 389 //   @pop               ... remove first entry
 390 //   @delete3           ... delete 4th entry
 391 //   @insert2:ksfo@900  ... insert "ksfo@900" as 3rd entry
 392 //   ksfo@900           ... append "ksfo@900"
 393 //
 394 void FGRouteMgr::Listener::valueChanged(SGPropertyNode *prop)
 395 {
 396     const char *s = prop->getStringValue();
 397     if (!strcmp(s, "@clear"))
 398         mgr->init();
 399     else if (!strcmp(s, "@pop"))
 400         mgr->pop_waypoint(0);
 401     else if (!strncmp(s, "@delete", 7))
 402         mgr->pop_waypoint(atoi(s + 7));
 403     else if (!strncmp(s, "@insert", 7)) {
 404         char *r;
 405         int pos = strtol(s + 7, &r, 10);
 406         if (*r++ != ':')
 407             return;
 408         while (isspace(*r))
 409             r++;
 410         if (*r)
 411             mgr->new_waypoint(r, pos);
 412     } else
 413         mgr->new_waypoint(s);
 414 }
 415
 416