src/Navaids/route.cxx

   1 // route.cxx - classes supporting waypoints and route structures
   2
   3 // Written by James Turner, started 2009.
   4 //
   5 // Copyright (C) 2009  Curtis L. Olson
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifdef HAVE_CONFIG_H
  22 # include "config.h"
  23 #endif
  24
  25 #include "route.hxx"
  26
  27 // std
  28 #include <map>
  29 #include <fstream>
  30
  31 // Boost
  32 #include <boost/algorithm/string/case_conv.hpp>
  33 #include <boost/algorithm/string.hpp>
  34 #include <boost/foreach.hpp>
  35
  36 // SimGear
  37 #include <simgear/structure/exception.hxx>
  38 #include <simgear/misc/sg_path.hxx>
  39 #include <simgear/magvar/magvar.hxx>
  40 #include <simgear/timing/sg_time.hxx>
  41 #include <simgear/misc/sgstream.hxx>
  42 #include <simgear/misc/strutils.hxx>
  43 #include <simgear/props/props_io.hxx>
  44
  45 // FlightGear
  46 #include <Main/globals.hxx>
  47 #include "Main/fg_props.hxx"
  48 #include <Navaids/procedure.hxx>
  49 #include <Navaids/waypoint.hxx>
  50 #include <Navaids/LevelDXML.hxx>
  51 #include <Airports/airport.hxx>
  52
  53 using std::string;
  54 using std::vector;
  55 using std::endl;
  56 using std::fstream;
  57
  58 namespace flightgear {
  59
  60 const double NO_MAG_VAR = -1000.0; // an impossible mag-var value
  61
  62 bool isMachRestrict(RouteRestriction rr)
  63 {
  64   return (rr == SPEED_RESTRICT_MACH) || (rr == SPEED_COMPUTED_MACH);
  65 }
  66
  67 Waypt::Waypt(RouteBase* aOwner) :
  68   _altitudeFt(0.0),
  69   _speed(0.0),
  70   _altRestrict(RESTRICT_NONE),
  71   _speedRestrict(RESTRICT_NONE),
  72   _owner(aOwner),
  73   _flags(0),
  74   _magVarDeg(NO_MAG_VAR)
  75 {
  76 }
  77
  78 Waypt::~Waypt()
  79 {
  80 }
  81
  82 std::string Waypt::ident() const
  83 {
  84   return "";
  85 }
  86
  87 bool Waypt::flag(WayptFlag aFlag) const
  88 {
  89   return ((_flags & aFlag) != 0);
  90 }
  91
  92 void Waypt::setFlag(WayptFlag aFlag, bool aV)
  93 {
  94     if (aFlag == 0) {
  95         throw sg_range_exception("invalid waypoint flag set");
  96     }
  97
  98   _flags = (_flags & ~aFlag);
  99   if (aV) _flags |= aFlag;
 100 }
 101
 102 bool Waypt::matches(Waypt* aOther) const
 103 {
 104   assert(aOther);
 105   if (ident() != aOther->ident()) { // cheap check first
 106     return false;
 107   }
 108
 109   return matches(aOther->position());
 110 }
 111
 112
 113 bool Waypt::matches(const SGGeod& aPos) const
 114 {
 115   double d = SGGeodesy::distanceM(position(), aPos);
 116   return (d < 100.0); // 100 metres seems plenty
 117 }
 118
 119 void Waypt::setAltitude(double aAlt, RouteRestriction aRestrict)
 120 {
 121   _altitudeFt = aAlt;
 122   _altRestrict = aRestrict;
 123 }
 124
 125 void Waypt::setSpeed(double aSpeed, RouteRestriction aRestrict)
 126 {
 127   _speed = aSpeed;
 128   _speedRestrict = aRestrict;
 129 }
 130
 131 double Waypt::speedKts() const
 132 {
 133   assert(_speedRestrict != SPEED_RESTRICT_MACH);
 134   return speed();
 135 }
 136
 137 double Waypt::speedMach() const
 138 {
 139   assert(_speedRestrict == SPEED_RESTRICT_MACH);
 140   return speed();
 141 }
 142
 143 double Waypt::magvarDeg() const
 144 {
 145   if (_magVarDeg == NO_MAG_VAR) {
 146     // derived classes with a default pos must override this method
 147     assert(!(position() == SGGeod()));
 148
 149     double jd = globals->get_time_params()->getJD();
 150     _magVarDeg = sgGetMagVar(position(), jd) * SG_RADIANS_TO_DEGREES;
 151   }
 152
 153   return _magVarDeg;
 154 }
 155
 156 double Waypt::headingRadialDeg() const
 157 {
 158   return 0.0;
 159 }
 160
 161 ///////////////////////////////////////////////////////////////////////////
 162 // persistence
 163
 164 static RouteRestriction restrictionFromString(const char* aStr)
 165 {
 166   std::string l = boost::to_lower_copy(std::string(aStr));
 167
 168   if (l == "at") return RESTRICT_AT;
 169   if (l == "above") return RESTRICT_ABOVE;
 170   if (l == "below") return RESTRICT_BELOW;
 171   if (l == "none") return RESTRICT_NONE;
 172   if (l == "mach") return SPEED_RESTRICT_MACH;
 173
 174   if (l.empty()) return RESTRICT_NONE;
 175   throw sg_io_exception("unknown restriction specification:" + l,
 176     "Route restrictFromString");
 177 }
 178
 179 static const char* restrictionToString(RouteRestriction aRestrict)
 180 {
 181   switch (aRestrict) {
 182   case RESTRICT_AT: return "at";
 183   case RESTRICT_BELOW: return "below";
 184   case RESTRICT_ABOVE: return "above";
 185   case RESTRICT_NONE: return "none";
 186   case SPEED_RESTRICT_MACH: return "mach";
 187
 188   default:
 189     throw sg_exception("invalid route restriction",
 190       "Route restrictToString");
 191   }
 192 }
 193
 194 Waypt* Waypt::createInstance(RouteBase* aOwner, const std::string& aTypeName)
 195 {
 196   Waypt* r = NULL;
 197   if (aTypeName == "basic") {
 198     r = new BasicWaypt(aOwner);
 199   } else if (aTypeName == "navaid") {
 200     r = new NavaidWaypoint(aOwner);
 201   } else if (aTypeName == "offset-navaid") {
 202     r = new OffsetNavaidWaypoint(aOwner);
 203   } else if (aTypeName == "hold") {
 204     r = new Hold(aOwner);
 205   } else if (aTypeName == "runway") {
 206     r = new RunwayWaypt(aOwner);
 207   } else if (aTypeName == "hdgToAlt") {
 208     r = new HeadingToAltitude(aOwner);
 209   } else if (aTypeName == "dmeIntercept") {
 210     r = new DMEIntercept(aOwner);
 211   } else if (aTypeName == "radialIntercept") {
 212     r = new RadialIntercept(aOwner);
 213   } else if (aTypeName == "vectors") {
 214     r = new ATCVectors(aOwner);
 215   }
 216
 217   if (!r || (r->type() != aTypeName)) {
 218     throw sg_exception("broken factory method for type:" + aTypeName,
 219       "Waypt::createInstance");
 220   }
 221
 222   return r;
 223 }
 224
 225 WayptRef Waypt::createFromProperties(RouteBase* aOwner, SGPropertyNode_ptr aProp)
 226 {
 227   if (!aProp->hasChild("type")) {
 228     throw sg_io_exception("bad props node, no type provided",
 229       "Waypt::createFromProperties");
 230   }
 231
 232   try {
 233     WayptRef nd(createInstance(aOwner, aProp->getStringValue("type")));
 234     nd->initFromProperties(aProp);
 235     return nd;
 236   } catch (sg_exception& e) {
 237     SG_LOG(SG_GENERAL, SG_WARN, "failed to create waypoint, trying basic:" << e.getMessage());
 238   }
 239
 240 // if we failed to make the waypoint, try again making a basic waypoint.
 241 // this handles the case where a navaid waypoint is missing, for example
 242   WayptRef nd(new BasicWaypt(aOwner));
 243   nd->initFromProperties(aProp);
 244   return nd;
 245 }
 246
 247 void Waypt::saveAsNode(SGPropertyNode* n) const
 248 {
 249   n->setStringValue("type", type());
 250   writeToProperties(n);
 251 }
 252
 253 void Waypt::initFromProperties(SGPropertyNode_ptr aProp)
 254 {
 255   if (aProp->hasChild("generated")) {
 256     setFlag(WPT_GENERATED, aProp->getBoolValue("generated"));
 257   }
 258
 259   if (aProp->hasChild("overflight")) {
 260     setFlag(WPT_OVERFLIGHT, aProp->getBoolValue("overflight"));
 261   }
 262
 263   if (aProp->hasChild("arrival")) {
 264     setFlag(WPT_ARRIVAL, aProp->getBoolValue("arrival"));
 265   }
 266
 267   if (aProp->hasChild("approach")) {
 268     setFlag(WPT_APPROACH, aProp->getBoolValue("approach"));
 269   }
 270
 271   if (aProp->hasChild("departure")) {
 272     setFlag(WPT_DEPARTURE, aProp->getBoolValue("departure"));
 273   }
 274
 275   if (aProp->hasChild("miss")) {
 276     setFlag(WPT_MISS, aProp->getBoolValue("miss"));
 277   }
 278
 279   if (aProp->hasChild("alt-restrict")) {
 280     _altRestrict = restrictionFromString(aProp->getStringValue("alt-restrict"));
 281     _altitudeFt = aProp->getDoubleValue("altitude-ft");
 282   }
 283
 284   if (aProp->hasChild("speed-restrict")) {
 285     _speedRestrict = restrictionFromString(aProp->getStringValue("speed-restrict"));
 286     _speed = aProp->getDoubleValue("speed");
 287   }
 288
 289
 290 }
 291
 292 void Waypt::writeToProperties(SGPropertyNode_ptr aProp) const
 293 {
 294   if (flag(WPT_OVERFLIGHT)) {
 295     aProp->setBoolValue("overflight", true);
 296   }
 297
 298   if (flag(WPT_DEPARTURE)) {
 299     aProp->setBoolValue("departure", true);
 300   }
 301
 302   if (flag(WPT_ARRIVAL)) {
 303     aProp->setBoolValue("arrival", true);
 304   }
 305
 306   if (flag(WPT_APPROACH)) {
 307     aProp->setBoolValue("approach", true);
 308   }
 309
 310   if (flag(WPT_MISS)) {
 311     aProp->setBoolValue("miss", true);
 312   }
 313
 314   if (flag(WPT_GENERATED)) {
 315     aProp->setBoolValue("generated", true);
 316   }
 317
 318   if (_altRestrict != RESTRICT_NONE) {
 319     aProp->setStringValue("alt-restrict", restrictionToString(_altRestrict));
 320     aProp->setDoubleValue("altitude-ft", _altitudeFt);
 321   }
 322
 323   if (_speedRestrict != RESTRICT_NONE) {
 324     aProp->setStringValue("speed-restrict", restrictionToString(_speedRestrict));
 325     aProp->setDoubleValue("speed", _speed);
 326   }
 327 }
 328
 329 void RouteBase::dumpRouteToKML(const WayptVec& aRoute, const std::string& aName)
 330 {
 331   SGPath p = "/Users/jmt/Desktop/" + aName + ".kml";
 332   std::fstream f;
 333   f.open(p.str().c_str(), fstream::out | fstream::app);
 334   if (!f.is_open()) {
 335     SG_LOG(SG_NAVAID, SG_WARN, "unable to open:" << p.str());
 336     return;
 337   }
 338
 339 // pre-amble
 340   f << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 341       "<kml xmlns=\"http://www.opengis.net/kml/2.2\">\n"
 342     "<Document>\n";
 343
 344   dumpRouteToKMLLineString(aName, aRoute, f);
 345
 346 // post-amble
 347   f << "</Document>\n"
 348     "</kml>" << endl;
 349   f.close();
 350 }
 351
 352 void RouteBase::dumpRouteToKMLLineString(const std::string& aIdent,
 353   const WayptVec& aRoute, std::ostream& aStream)
 354 {
 355   // preamble
 356   aStream << "<Placemark>\n";
 357   aStream << "<name>" << aIdent << "</name>\n";
 358   aStream << "<LineString>\n";
 359   aStream << "<tessellate>1</tessellate>\n";
 360   aStream << "<coordinates>\n";
 361
 362   // waypoints
 363   for (unsigned int i=0; i<aRoute.size(); ++i) {
 364     SGGeod pos = aRoute[i]->position();
 365     aStream << pos.getLongitudeDeg() << "," << pos.getLatitudeDeg() << " " << endl;
 366   }
 367
 368   // postable
 369   aStream << "</coordinates>\n"
 370     "</LineString>\n"
 371     "</Placemark>\n" << endl;
 372 }
 373
 374 void RouteBase::loadAirportProcedures(const SGPath& aPath, FGAirport* aApt)
 375 {
 376   assert(aApt);
 377   try {
 378     NavdataVisitor visitor(aApt, aPath);
 379     readXML(aPath.str(), visitor);
 380   } catch (sg_io_exception& ex) {
 381     SG_LOG(SG_NAVAID, SG_WARN, "failure parsing procedures: " << aPath.str() <<
 382       "\n\t" << ex.getMessage() << "\n\tat:" << ex.getLocation().asString());
 383   } catch (sg_exception& ex) {
 384     SG_LOG(SG_NAVAID, SG_WARN, "failure parsing procedures: " << aPath.str() <<
 385       "\n\t" << ex.getMessage());
 386   }
 387 }
 388
 389 } // of namespace flightgear