]> git.mxchange.org Git - flightgear.git/blobdiff - src/Autopilot/route_mgr.cxx
Move viewer-related sources to separate folder.
[flightgear.git] / src / Autopilot / route_mgr.cxx
index 1b37fa2562623dacee3a5c521fc2fdefeb1a260e..b16318da76f5906054f5a081a3de6afa6ad18b6f 100644 (file)
@@ -40,6 +40,7 @@
 
 #include <simgear/misc/strutils.hxx>
 #include <simgear/structure/exception.hxx>
+#include <simgear/structure/commands.hxx>
 #include <simgear/misc/sgstream.hxx>
 
 #include <simgear/props/props_io.hxx>
@@ -109,14 +110,169 @@ PropertyWatcher* createWatcher(T* obj, void (T::*m)())
   return new MethodPropertyWatcher<T>(obj, m);
 }
 
+static bool commandLoadFlightPlan(const SGPropertyNode* arg)
+{
+  FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
+  SGPath path(arg->getStringValue("path"));
+  return self->loadRoute(path);
+}
+
+static bool commandSaveFlightPlan(const SGPropertyNode* arg)
+{
+  FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
+  SGPath path(arg->getStringValue("path"));
+  return self->saveRoute(path);
+}
+
+static bool commandActivateFlightPlan(const SGPropertyNode* arg)
+{
+  FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
+  bool activate = arg->getBoolValue("activate", true);
+  if (activate) {
+    self->activate();
+  } else {
+    
+  }
+  
+  return true;
+}
+
+static bool commandClearFlightPlan(const SGPropertyNode*)
+{
+  FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
+  self->clearRoute();
+  return true;
+}
+
+static bool commandSetActiveWaypt(const SGPropertyNode* arg)
+{
+  FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
+  int index = arg->getIntValue("index");
+  if ((index < 0) || (index >= self->numWaypts())) {
+    return false;
+  }
+  
+  self->jumpToIndex(index);
+  return true;
+}
+
+static bool commandInsertWaypt(const SGPropertyNode* arg)
+{
+  FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
+  int index = arg->getIntValue("index");
+  std::string ident(arg->getStringValue("id"));
+  int alt = arg->getIntValue("altitude-ft", -999);
+  int ias = arg->getIntValue("speed-knots", -999);
+  
+  WayptRef wp;
+// lat/lon may be supplied to narrow down navaid search, or to specify
+// a raw waypoint
+  SGGeod pos;
+  if (arg->hasChild("longitude-deg")) {
+    pos = SGGeod::fromDeg(arg->getDoubleValue("longitude-deg"),
+                               arg->getDoubleValue("latitude-deg"));
+  }
+  
+  if (arg->hasChild("navaid")) {
+    FGPositionedRef p = FGPositioned::findClosestWithIdent(arg->getStringValue("navaid"), pos);
+    
+    if (arg->hasChild("navaid", 1)) {
+      // intersection of two radials
+      FGPositionedRef p2 = FGPositioned::findClosestWithIdent(arg->getStringValue("navaid[1]"), pos);
+      if (!p2) {
+        SG_LOG( SG_AUTOPILOT, SG_INFO, "Unable to find FGPositioned with ident:" << arg->getStringValue("navaid[1]"));
+        return false;
+      }
+      
+      double r1 = arg->getDoubleValue("radial"),
+        r2 = arg->getDoubleValue("radial[1]");
+      
+      SGGeod intersection;
+      bool ok = SGGeodesy::radialIntersection(p->geod(), r1, p2->geod(), r2, intersection);
+      if (!ok) {
+        SG_LOG(SG_AUTOPILOT, SG_INFO, "no valid intersection for:" << p->ident() 
+                << "," << p2->ident());
+        return false;
+      }
+      
+      std::string name = p->ident() + "-" + p2->ident();
+      wp = new BasicWaypt(intersection, name, NULL);
+    } else if (arg->hasChild("offset-nm") && arg->hasChild("radial")) {
+      // offset radial from navaid
+      double radial = arg->getDoubleValue("radial");
+      double distanceNm = arg->getDoubleValue("offset-nm");
+      //radial += magvar->getDoubleValue(); // convert to true bearing
+      wp = new OffsetNavaidWaypoint(p, NULL, radial, distanceNm);
+    } else {
+      wp = new NavaidWaypoint(p, NULL);
+    }
+  } else if (arg->hasChild("airport")) {
+    const FGAirport* apt = fgFindAirportID(arg->getStringValue("airport"));
+    if (!apt) {
+      SG_LOG(SG_AUTOPILOT, SG_INFO, "no such airport" << arg->getStringValue("airport"));
+      return false;
+    }
+    
+    if (arg->hasChild("runway")) {
+      if (!apt->hasRunwayWithIdent(arg->getStringValue("runway"))) {
+        SG_LOG(SG_AUTOPILOT, SG_INFO, "No runway: " << arg->getStringValue("runway") << " at " << apt->ident());
+        return false;
+      }
+      
+      FGRunway* runway = apt->getRunwayByIdent(arg->getStringValue("runway"));
+      wp = new RunwayWaypt(runway, NULL);
+    } else {
+      wp = new NavaidWaypoint((FGAirport*) apt, NULL);
+    }
+  } else if (arg->hasChild("text")) {
+    wp = self->waypointFromString(arg->getStringValue("text"));
+  } else if (!(pos == SGGeod())) {
+    // just a raw lat/lon
+    wp = new BasicWaypt(pos, ident, NULL);
+  } else {
+    return false; // failed to build waypoint
+  }
+  
+  if (alt >= 0) {
+    wp->setAltitude(alt, flightgear::RESTRICT_AT);
+  }
+  
+  if (ias > 0) {
+    wp->setSpeed(ias, flightgear::RESTRICT_AT);
+  }
+
+  self->insertWayptAtIndex(wp, index);
+  return true;
+}
+
+static bool commandDeleteWaypt(const SGPropertyNode* arg)
+{
+  FGRouteMgr* self = (FGRouteMgr*) globals->get_subsystem("route-manager");
+  int index = arg->getIntValue("index");
+  self->removeWayptAtIndex(index);
+  return true;
+}
+
+/////////////////////////////////////////////////////////////////////////////
+
 FGRouteMgr::FGRouteMgr() :
   _currentIndex(0),
   input(fgGetNode( RM "input", true )),
-  mirror(fgGetNode( RM "route", true ))
+  mirror(fgGetNode( RM "route", true )),
+  _departureWatcher(NULL),
+  _arrivalWatcher(NULL)
 {
   listener = new InputListener(this);
   input->setStringValue("");
   input->addChangeListener(listener);
+  
+  SGCommandMgr::instance()->addCommand("load-flightplan", commandLoadFlightPlan);
+  SGCommandMgr::instance()->addCommand("save-flightplan", commandSaveFlightPlan);
+  SGCommandMgr::instance()->addCommand("activate-flightplan", commandActivateFlightPlan);
+  SGCommandMgr::instance()->addCommand("clear-flightplan", commandClearFlightPlan);
+  SGCommandMgr::instance()->addCommand("set-active-waypt", commandSetActiveWaypt);
+  SGCommandMgr::instance()->addCommand("insert-waypt", commandInsertWaypt);
+  SGCommandMgr::instance()->addCommand("delete-waypt", commandDeleteWaypt);
 }
 
 
@@ -124,6 +280,8 @@ FGRouteMgr::~FGRouteMgr()
 {
   input->removeChangeListener(listener);
   delete listener;
+  delete _departureWatcher;
+  delete _arrivalWatcher;
 }
 
 
@@ -142,6 +300,7 @@ void FGRouteMgr::init() {
     &FGRouteMgr::getDepartureName, NULL));
   departure->setStringValue("runway", "");
   
+  delete _departureWatcher;
   _departureWatcher = createWatcher(this, &FGRouteMgr::departureChanged);
   _departureWatcher->watch(departure->getChild("runway"));
   
@@ -157,6 +316,7 @@ void FGRouteMgr::init() {
   destination->tie("name", SGRawValueMethods<FGRouteMgr, const char*>(*this, 
     &FGRouteMgr::getDestinationName, NULL));
   
+  delete _arrivalWatcher;
   _arrivalWatcher = createWatcher(this, &FGRouteMgr::arrivalChanged);
   _arrivalWatcher->watch(destination->getChild("runway", 0, true));
   
@@ -181,6 +341,8 @@ void FGRouteMgr::init() {
   
   totalDistance = fgGetNode(RM "total-distance", true);
   totalDistance->setDoubleValue(0.0);
+  distanceToGo = fgGetNode(RM "distance-remaining-nm", true);
+  distanceToGo->setDoubleValue(0.0);
   
   ete = fgGetNode(RM "ete", true);
   ete->setDoubleValue(0.0);
@@ -225,9 +387,9 @@ void FGRouteMgr::init() {
 void FGRouteMgr::postinit()
 {
   SGPath path(_pathNode->getStringValue());
-  if (path.exists()) {
-    SG_LOG(SG_AUTOPILOT, SG_INFO, "loading flight-plan from:" << path.str());
-    loadRoute();
+  if (!path.isNull()) {
+    SG_LOG(SG_AUTOPILOT, SG_INFO, "loading flight-plan from: " << path.str());
+    loadRoute(path);
   }
   
 // this code only matters for the --wp option now - perhaps the option
@@ -244,6 +406,7 @@ void FGRouteMgr::postinit()
     }
     
     SG_LOG(SG_AUTOPILOT, SG_INFO, "loaded initial waypoints:" << _route.size());
+    update_mirror();
   }
 
   weightOnWheels = fgGetNode("/gear/gear[0]/wow", true);
@@ -295,34 +458,44 @@ void FGRouteMgr::update( double dt )
   double distanceM;
   boost::tie(courseDeg, distanceM) = curWpt->courseAndDistanceFrom(currentPos);
   
-// update wp0 / wp1 / wp-last for legacy users
+// update wp0 / wp1 / wp-last
   wp0->setDoubleValue("dist", distanceM * SG_METER_TO_NM);
+  wp0->setDoubleValue("true-bearing-deg", courseDeg);
   courseDeg -= magvar->getDoubleValue(); // expose magnetic bearing
   wp0->setDoubleValue("bearing-deg", courseDeg);
   setETAPropertyFromDistance(wp0->getChild("eta"), distanceM);
   
+  double totalPathDistance = totalDistance->getDoubleValue() * SG_NM_TO_METER;
   double totalDistanceRemaining = distanceM; // distance to current waypoint
+  double pathDistance = cachedWaypointPathTotalDistance(_currentIndex);
+  
+// total distance to go, is direct distance to wp0, plus the remaining
+// path distance from wp0
+  totalDistanceRemaining += (totalPathDistance - pathDistance);
+  
+  wp0->setDoubleValue("distance-along-route-nm", 
+                      pathDistance * SG_METER_TO_NM);
+  wp0->setDoubleValue("remaining-distance-nm", 
+                      (totalPathDistance - pathDistance) * SG_METER_TO_NM);
   
   Waypt* nextWpt = nextWaypt();
   if (nextWpt) {
     boost::tie(courseDeg, distanceM) = nextWpt->courseAndDistanceFrom(currentPos);
      
     wp1->setDoubleValue("dist", distanceM * SG_METER_TO_NM);
+    wp1->setDoubleValue("true-bearing-deg", courseDeg);
     courseDeg -= magvar->getDoubleValue(); // expose magnetic bearing
     wp1->setDoubleValue("bearing-deg", courseDeg);
     setETAPropertyFromDistance(wp1->getChild("eta"), distanceM);
-  }
-  
-  Waypt* prev = curWpt;
-  for (unsigned int i=_currentIndex + 1; i<_route.size(); ++i) {
-    Waypt* w = _route[i];
-    if (w->flag(WPT_DYNAMIC)) continue;
-    totalDistanceRemaining += SGGeodesy::distanceM(prev->position(), w->position());
-    prev = w;
-    
     
+    double pathDistance = cachedWaypointPathTotalDistance(_currentIndex + 1);    
+    wp1->setDoubleValue("distance-along-route-nm", 
+                        pathDistance * SG_METER_TO_NM);
+    wp1->setDoubleValue("remaining-distance-nm", 
+                        (totalPathDistance - pathDistance) * SG_METER_TO_NM);
   }
   
+  distanceToGo->setDoubleValue(totalDistanceRemaining * SG_METER_TO_NM);
   wpn->setDoubleValue("dist", totalDistanceRemaining * SG_METER_TO_NM);
   ete->setDoubleValue(totalDistanceRemaining * SG_METER_TO_NM / groundSpeed * 3600.0);
   setETAPropertyFromDistance(wpn->getChild("eta"), totalDistanceRemaining);
@@ -385,9 +558,22 @@ flightgear::WayptRef FGRouteMgr::removeWayptAtIndex(int aIndex)
   return w;
 }
   
+struct NotGeneratedWayptPredicate : public std::unary_function<const Waypt*, bool>
+{
+  bool operator() (const Waypt* w) const
+  {
+    return (w->flag(WPT_GENERATED) == false);
+  }
+};
+
+
 void FGRouteMgr::clearRoute()
 {
-  _route.clear();
+// erase all non-generated waypoints
+  WayptVec::iterator r =  
+    std::remove_if(_route.begin(), _route.end(), NotGeneratedWayptPredicate());
+  _route.erase(r, _route.end());
+  
   _currentIndex = -1;
   
   update_mirror();
@@ -818,13 +1004,14 @@ void FGRouteMgr::update_mirror()
   mirror->removeChildren("wp");
   
   int num = numWaypts();
+  double totalDistanceEnroute = 0.0;
+    
   for (int i = 0; i < num; i++) {
     Waypt* wp = _route[i];
     SGPropertyNode *prop = mirror->getChild("wp", i, 1);
 
     const SGGeod& pos(wp->position());
     prop->setStringValue("id", wp->ident().c_str());
-    //prop->setStringValue("name", wp.get_name().c_str());
     prop->setDoubleValue("longitude-deg", pos.getLongitudeDeg());
     prop->setDoubleValue("latitude-deg",pos.getLatitudeDeg());
    
@@ -835,12 +1022,15 @@ void FGRouteMgr::update_mirror()
         next->courseAndDistanceFrom(pos);
       prop->setDoubleValue("leg-bearing-true-deg", crsDist.first);
       prop->setDoubleValue("leg-distance-nm", crsDist.second * SG_METER_TO_NM);
+      prop->setDoubleValue("distance-along-route-nm", totalDistanceEnroute);
+      totalDistanceEnroute += crsDist.second * SG_METER_TO_NM;
     }
     
     if (wp->altitudeRestriction() != RESTRICT_NONE) {
       double ft = wp->altitudeFt();
       prop->setDoubleValue("altitude-m", ft * SG_FEET_TO_METER);
       prop->setDoubleValue("altitude-ft", ft);
+      prop->setIntValue("flight-level", static_cast<int>(ft / 1000) * 10);
     } else {
       prop->setDoubleValue("altitude-m", -9999.9);
       prop->setDoubleValue("altitude-ft", -9999.9);
@@ -875,6 +1065,28 @@ void FGRouteMgr::update_mirror()
   if (rmDlg) {
     rmDlg->updateValues();
   }
+    
+  if (_departure) {
+    departure->setDoubleValue("field-elevation-ft", _departure->getElevation());
+  }
+  
+  if (_destination) {
+    destination->setDoubleValue("field-elevation-ft", _destination->getElevation());
+  }
+  
+  totalDistance->setDoubleValue(totalDistanceEnroute);
+}
+
+double FGRouteMgr::cachedLegPathDistanceM(int index) const
+{
+  SGPropertyNode *prop = mirror->getChild("wp", index, 1);
+  return prop->getDoubleValue("leg-distance-nm") * SG_NM_TO_METER;
+}
+
+double FGRouteMgr::cachedWaypointPathTotalDistance(int index) const
+{
+  SGPropertyNode *prop = mirror->getChild("wp", index, 1);
+  return prop->getDoubleValue("distance-along-route-nm") * SG_NM_TO_METER;
 }
 
 // command interface /autopilot/route-manager/input:
@@ -897,11 +1109,11 @@ void FGRouteMgr::InputListener::valueChanged(SGPropertyNode *prop)
     else if (!strcmp(s, "@ACTIVATE"))
         mgr->activate();
     else if (!strcmp(s, "@LOAD")) {
-      mgr->loadRoute();
+      SGPath path(mgr->_pathNode->getStringValue());
+      mgr->loadRoute(path);
     } else if (!strcmp(s, "@SAVE")) {
-      mgr->saveRoute();
-    } else if (!strcmp(s, "@POP")) {
-      SG_LOG(SG_AUTOPILOT, SG_WARN, "route-manager @POP command is deprecated");
+      SGPath path(mgr->_pathNode->getStringValue());
+      mgr->saveRoute(path);
     } else if (!strcmp(s, "@NEXT")) {
       mgr->jumpToIndex(mgr->_currentIndex + 1);
     } else if (!strcmp(s, "@PREVIOUS")) {
@@ -981,15 +1193,7 @@ void FGRouteMgr::initAtPosition()
 
 bool FGRouteMgr::haveUserWaypoints() const
 {
-  for (int i = 0; i < numWaypts(); i++) {
-    if (!_route[i]->flag(WPT_GENERATED)) {
-      // have a non-generated waypoint, we're done
-      return true;
-    }
-  }
-  
-  // all waypoints are generated
-  return false;
+  return std::find_if(_route.begin(), _route.end(), NotGeneratedWayptPredicate()) != _route.end();
 }
 
 bool FGRouteMgr::activate()
@@ -1119,9 +1323,17 @@ Waypt* FGRouteMgr::wayptAtIndex(int index) const
   return _route[index];
 }
 
-void FGRouteMgr::saveRoute()
+SGPropertyNode_ptr FGRouteMgr::wayptNodeAtIndex(int index) const
+{
+    if ((index < 0) || (index >= numWaypts())) {
+        throw sg_range_exception("waypt index out of range", "FGRouteMgr::wayptAtIndex");
+    }
+    
+    return mirror->getChild("wp", index);
+}
+
+bool FGRouteMgr::saveRoute(const SGPath& path)
 {
-  SGPath path(_pathNode->getStringValue());
   SG_LOG(SG_IO, SG_INFO, "Saving route to " << path.str());
   try {
     SGPropertyNode_ptr d(new SGPropertyNode);
@@ -1148,42 +1360,60 @@ void FGRouteMgr::saveRoute()
       wpt->saveAsNode(routeNode->getChild("wp", i, true));
     } // of waypoint iteration
     writeProperties(path.str(), d, true /* write-all */);
+    return true;
   } catch (sg_exception& e) {
-    SG_LOG(SG_IO, SG_WARN, "failed to save flight-plan:" << e.getMessage());
+    SG_LOG(SG_IO, SG_ALERT, "Failed to save flight-plan '" << path.str() << "'. " << e.getMessage());
+    return false;
   }
 }
 
-void FGRouteMgr::loadRoute()
+bool FGRouteMgr::loadRoute(const SGPath& path)
 {
+  if (!path.exists())
+  {
+      SG_LOG(SG_IO, SG_ALERT, "Failed to load flight-plan '" << path.str()
+              << "'. The file does not exist.");
+      return false;
+  }
+    
   // deactivate route first
   active->setBoolValue(false);
   
   SGPropertyNode_ptr routeData(new SGPropertyNode);
-  SGPath path(_pathNode->getStringValue());
   
   SG_LOG(SG_IO, SG_INFO, "going to read flight-plan from:" << path.str());
     
+  bool Status = false;
   try {
     readProperties(path.str(), routeData);
   } catch (sg_exception& ) {
     // if XML parsing fails, the file might be simple textual list of waypoints
-    loadPlainTextRoute(path);
-    return;
+    Status = loadPlainTextRoute(path);
+    routeData = 0;
   }
-  
-  try {
-    int version = routeData->getIntValue("version", 1);
-    if (version == 1) {
-      loadVersion1XMLRoute(routeData);
-    } else if (version == 2) {
-      loadVersion2XMLRoute(routeData);
-    } else {
-      throw sg_io_exception("unsupported XML route version");
-    }
-  } catch (sg_exception& e) {
-    SG_LOG(SG_IO, SG_WARN, "failed to load flight-plan (from '" << e.getOrigin()
-      << "'):" << e.getMessage());
+
+  if (routeData.valid())
+  {
+      try {
+        int version = routeData->getIntValue("version", 1);
+        if (version == 1) {
+          loadVersion1XMLRoute(routeData);
+        } else if (version == 2) {
+          loadVersion2XMLRoute(routeData);
+        } else {
+          throw sg_io_exception("unsupported XML route version");
+        }
+        Status = true;
+      } catch (sg_exception& e) {
+        SG_LOG(SG_IO, SG_ALERT, "Failed to load flight-plan '" << e.getOrigin()
+          << "'. " << e.getMessage());
+        Status = false;
+      }
   }
+
+  update_mirror();
+
+  return Status;
 }
 
 void FGRouteMgr::loadXMLRouteHeader(SGPropertyNode_ptr routeData)
@@ -1299,14 +1529,14 @@ WayptRef FGRouteMgr::parseVersion1XMLWaypt(SGPropertyNode* aWP)
   return w;
 }
 
-void FGRouteMgr::loadPlainTextRoute(const SGPath& path)
+bool FGRouteMgr::loadPlainTextRoute(const SGPath& path)
 {
-  sg_gzifstream in(path.str().c_str());
-  if (!in.is_open()) {
-    return;
-  }
-  
   try {
+    sg_gzifstream in(path.str().c_str());
+    if (!in.is_open()) {
+        throw sg_io_exception("Cannot open file for reading.");
+    }
+  
     WayptVec wpts;
     while (!in.eof()) {
       string line;
@@ -1323,15 +1553,17 @@ void FGRouteMgr::loadPlainTextRoute(const SGPath& path)
       
       WayptRef w = waypointFromString(line);
       if (!w) {
-        throw sg_io_exception("failed to create waypoint from line:" + line);
+        throw sg_io_exception("Failed to create waypoint from line '" + line + "'.");
       }
       
       wpts.push_back(w);
     } // of line iteration
   
     _route = wpts;
+    return true;
   } catch (sg_exception& e) {
-    SG_LOG(SG_IO, SG_WARN, "failed to load route from:" << path.str() << ":" << e.getMessage());
+    SG_LOG(SG_IO, SG_ALERT, "Failed to load route from: '" << path.str() << "'. " << e.getMessage());
+    return false;
   }
 }
 
@@ -1392,3 +1624,42 @@ void FGRouteMgr::setDestinationICAO(const char* aIdent)
   
   arrivalChanged();
 }
+
+FGAirportRef FGRouteMgr::departureAirport() const
+{
+    return _departure;
+}
+
+FGAirportRef FGRouteMgr::destinationAirport() const
+{
+    return _destination;
+}
+
+FGRunway* FGRouteMgr::departureRunway() const
+{
+    if (!_departure) {
+        return NULL;
+    }
+    
+    string runwayId(departure->getStringValue("runway"));
+    if (!_departure->hasRunwayWithIdent(runwayId)) {
+        return NULL;
+    }
+    
+    return _departure->getRunwayByIdent(runwayId);
+}
+
+FGRunway* FGRouteMgr::destinationRunway() const
+{
+    if (!_destination) {
+        return NULL;
+    }
+    
+    string runwayId(destination->getStringValue("runway"));
+    if (!_destination->hasRunwayWithIdent(runwayId)) {
+        return NULL;
+    }
+    
+    return _destination->getRunwayByIdent(runwayId);
+}
+