src/Navaids/positioned.cxx

   1 // positioned.cxx - base class for objects which are positioned
   2 //
   3 // Copyright (C) 2008 James Turner
   4 //
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License as
   7 // published by the Free Software Foundation; either version 2 of the
   8 // License, or (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful, but
  11 // WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 // General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18 //
  19 // $Id$
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include "config.h"
  23 #endif
  24
  25 #include "positioned.hxx"
  26
  27 #include <map>
  28 #include <set>
  29 #include <algorithm> // for sort
  30 #include <queue>
  31 #include <memory>
  32
  33 #include <boost/algorithm/string/case_conv.hpp>
  34 #include <boost/algorithm/string/predicate.hpp>
  35
  36 #include <simgear/timing/timestamp.hxx>
  37 #include <simgear/debug/logstream.hxx>
  38 #include <simgear/structure/exception.hxx>
  39 #include <simgear/math/SGGeometry.hxx>
  40 #include <simgear/sg_inlines.h>
  41
  42 #include "Navaids/PositionedOctree.hxx"
  43
  44 using std::string;
  45 using namespace flightgear;
  46
  47 static void validateSGGeod(const SGGeod& geod)
  48 {
  49   if (SGMisc<double>::isNaN(geod.getLatitudeDeg()) ||
  50       SGMisc<double>::isNaN(geod.getLongitudeDeg()))
  51   {
  52     throw sg_range_exception("position is invalid, NaNs");
  53   }
  54 }
  55
  56
  57 ///////////////////////////////////////////////////////////////////////////////
  58
  59 FGPositioned::FGPositioned(PositionedID aGuid, Type ty, const std::string& aIdent, const SGGeod& aPos) :
  60   mGuid(aGuid),
  61   mPosition(aPos),
  62   mCart(SGVec3d::fromGeod(mPosition)),
  63   mType(ty),
  64   mIdent(aIdent)
  65 {
  66 }
  67
  68 FGPositioned::~FGPositioned()
  69 {
  70 //  std::cout << "destroying:" << mIdent << "/" << nameForType(mType) << std::endl;
  71 }
  72
  73 FGPositioned*
  74 FGPositioned::createUserWaypoint(const std::string& aIdent, const SGGeod& aPos)
  75 {
  76   NavDataCache* cache = NavDataCache::instance();
  77   TypeFilter filter(WAYPOINT);
  78   FGPositioned::List existing = cache->findAllWithIdent(aIdent, &filter, true);
  79   if (!existing.empty()) {
  80     SG_LOG(SG_NAVAID, SG_WARN, "attempt to insert duplicate WAYPOINT:" << aIdent);
  81     return existing.front().ptr();
  82   }
  83
  84   PositionedID id = cache->createPOI(WAYPOINT, aIdent, aPos);
  85   return cache->loadById(id);
  86 }
  87
  88 void FGPositioned::deleteUserWaypoint(const std::string& aIdent)
  89 {
  90   NavDataCache* cache = NavDataCache::instance();
  91   cache->removePOI(WAYPOINT, aIdent);
  92 }
  93
  94
  95 const SGVec3d&
  96 FGPositioned::cart() const
  97 {
  98   return mCart;
  99 }
 100
 101 FGPositioned::Type FGPositioned::typeFromName(const std::string& aName)
 102 {
 103   if (aName.empty() || (aName == "")) {
 104     return INVALID;
 105   }
 106
 107   typedef struct {
 108     const char* _name;
 109     Type _ty;
 110   } NameTypeEntry;
 111
 112   const NameTypeEntry names[] = {
 113     {"airport", AIRPORT},
 114     {"vor", VOR},
 115     {"loc", LOC},
 116     {"ils", ILS},
 117     {"gs", GS},
 118     {"ndb", NDB},
 119     {"wpt", WAYPOINT},
 120     {"fix", FIX},
 121     {"tacan", TACAN},
 122     {"dme", DME},
 123     {"atis", FREQ_ATIS},
 124     {"awos", FREQ_AWOS},
 125     {"tower", FREQ_TOWER},
 126     {"ground", FREQ_GROUND},
 127     {"approach", FREQ_APP_DEP},
 128     {"departure", FREQ_APP_DEP},
 129     {"runway", RUNWAY},
 130     {"helipad", HELIPAD},
 131     {"country", COUNTRY},
 132     {"city", CITY},
 133     {"town", TOWN},
 134
 135   // aliases
 136     {"gnd", FREQ_GROUND},
 137     {"twr", FREQ_TOWER},
 138     {"waypoint", WAYPOINT},
 139     {"apt", AIRPORT},
 140     {"arpt", AIRPORT},
 141     {"rwy", RUNWAY},
 142     {"any", INVALID},
 143     {"all", INVALID},
 144
 145     {NULL, INVALID}
 146   };
 147
 148   std::string lowerName(boost::to_lower_copy(aName));
 149
 150   for (const NameTypeEntry* n = names; (n->_name != NULL); ++n) {
 151     if (::strcmp(n->_name, lowerName.c_str()) == 0) {
 152       return n->_ty;
 153     }
 154   }
 155
 156   SG_LOG(SG_NAVAID, SG_WARN, "FGPositioned::typeFromName: couldn't match:" << aName);
 157   return INVALID;
 158 }
 159
 160 const char* FGPositioned::nameForType(Type aTy)
 161 {
 162  switch (aTy) {
 163  case RUNWAY: return "runway";
 164  case HELIPAD: return "helipad";
 165  case TAXIWAY: return "taxiway";
 166  case PAVEMENT: return "pavement";
 167  case PARKING: return "parking stand";
 168  case FIX: return "fix";
 169  case VOR: return "VOR";
 170  case NDB: return "NDB";
 171  case ILS: return "ILS";
 172  case LOC: return "localiser";
 173  case GS: return "glideslope";
 174  case OM: return "outer-marker";
 175  case MM: return "middle-marker";
 176  case IM: return "inner-marker";
 177  case AIRPORT: return "airport";
 178  case HELIPORT: return "heliport";
 179  case SEAPORT: return "seaport";
 180  case WAYPOINT: return "waypoint";
 181  case DME: return "dme";
 182  case TACAN: return "tacan";
 183  case FREQ_TOWER: return "tower";
 184  case FREQ_ATIS: return "atis";
 185  case FREQ_AWOS: return "awos";
 186  case FREQ_GROUND: return "ground";
 187  case FREQ_CLEARANCE: return "clearance";
 188  case FREQ_UNICOM: return "unicom";
 189  case FREQ_APP_DEP: return "approach-departure";
 190  case TAXI_NODE: return "taxi-node";
 191  case COUNTRY: return "country";
 192  case CITY: return "city";
 193  case TOWN: return "town";
 194  default:
 195   return "unknown";
 196  }
 197 }
 198
 199 ///////////////////////////////////////////////////////////////////////////////
 200 // search / query functions
 201
 202 FGPositionedRef
 203 FGPositioned::findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter)
 204 {
 205   validateSGGeod(aPos);
 206   return NavDataCache::instance()->findClosestWithIdent(aIdent, aPos, aFilter);
 207 }
 208
 209 FGPositionedRef
 210 FGPositioned::findFirstWithIdent(const std::string& aIdent, Filter* aFilter)
 211 {
 212   if (aIdent.empty()) {
 213     return NULL;
 214   }
 215
 216   List r = NavDataCache::instance()->findAllWithIdent(aIdent, aFilter, true);
 217   if (r.empty()) {
 218     return NULL;
 219   }
 220
 221   return r.front();
 222 }
 223
 224 FGPositioned::List
 225 FGPositioned::findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter)
 226 {
 227   validateSGGeod(aPos);
 228
 229   List result;
 230   Octree::findAllWithinRange(SGVec3d::fromGeod(aPos),
 231     aRangeNm * SG_NM_TO_METER, aFilter, result, 0xffffff);
 232   return result;
 233 }
 234
 235 FGPositioned::List
 236 FGPositioned::findWithinRangePartial(const SGGeod& aPos, double aRangeNm, Filter* aFilter, bool& aPartial)
 237 {
 238   validateSGGeod(aPos);
 239
 240   int limitMsec = 32;
 241   List result;
 242   aPartial = Octree::findAllWithinRange(SGVec3d::fromGeod(aPos),
 243                              aRangeNm * SG_NM_TO_METER, aFilter, result,
 244                                         limitMsec);
 245   return result;
 246 }
 247
 248 FGPositioned::List
 249 FGPositioned::findAllWithIdent(const std::string& aIdent, Filter* aFilter, bool aExact)
 250 {
 251   return NavDataCache::instance()->findAllWithIdent(aIdent, aFilter, aExact);
 252 }
 253
 254 FGPositioned::List
 255 FGPositioned::findAllWithName(const std::string& aName, Filter* aFilter, bool aExact)
 256 {
 257   return NavDataCache::instance()->findAllWithName(aName, aFilter, aExact);
 258 }
 259
 260 FGPositionedRef
 261 FGPositioned::findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter)
 262 {
 263   validateSGGeod(aPos);
 264
 265   List l(findClosestN(aPos, 1, aCutoffNm, aFilter));
 266   if (l.empty()) {
 267     return NULL;
 268   }
 269
 270   assert(l.size() == 1);
 271   return l.front();
 272 }
 273
 274 FGPositioned::List
 275 FGPositioned::findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter)
 276 {
 277   validateSGGeod(aPos);
 278
 279   List result;
 280   int limitMsec = 0xffff;
 281   Octree::findNearestN(SGVec3d::fromGeod(aPos), aN, aCutoffNm * SG_NM_TO_METER, aFilter, result, limitMsec);
 282   return result;
 283 }
 284
 285 FGPositioned::List
 286 FGPositioned::findClosestNPartial(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter, bool &aPartial)
 287 {
 288     validateSGGeod(aPos);
 289
 290     List result;
 291     int limitMsec = 32;
 292     aPartial = Octree::findNearestN(SGVec3d::fromGeod(aPos), aN, aCutoffNm * SG_NM_TO_METER, aFilter, result,
 293                         limitMsec);
 294     return result;
 295 }
 296
 297 void
 298 FGPositioned::sortByRange(List& aResult, const SGGeod& aPos)
 299 {
 300   validateSGGeod(aPos);
 301
 302   SGVec3d cartPos(SGVec3d::fromGeod(aPos));
 303 // computer ordering values
 304   Octree::FindNearestResults r;
 305   List::iterator it = aResult.begin(), lend = aResult.end();
 306   for (; it != lend; ++it) {
 307     double d2 = distSqr((*it)->cart(), cartPos);
 308     r.push_back(Octree::OrderedPositioned(*it, d2));
 309   }
 310
 311 // sort
 312   std::sort(r.begin(), r.end());
 313
 314 // convert to a plain list
 315   unsigned int count = aResult.size();
 316   for (unsigned int i=0; i<count; ++i) {
 317     aResult[i] = r[i].get();
 318   }
 319 }
 320
 321 void FGPositioned::modifyPosition(const SGGeod& newPos)
 322 {
 323   const_cast<SGGeod&>(mPosition) = newPos;
 324   const_cast<SGVec3d&>(mCart) = SGVec3d::fromGeod(newPos);
 325 }
 326
 327 FGPositioned::TypeFilter::TypeFilter(Type aTy) :
 328   mMinType(aTy),
 329   mMaxType(aTy)
 330 {
 331   addType(aTy);
 332 }
 333
 334 void FGPositioned::TypeFilter::addType(Type aTy)
 335 {
 336   if (aTy == INVALID) {
 337     return;
 338   }
 339
 340   types.push_back(aTy);
 341   mMinType = std::min(mMinType, aTy);
 342   mMaxType = std::max(mMaxType, aTy);
 343 }
 344
 345 bool
 346 FGPositioned::TypeFilter::pass(FGPositioned* aPos) const
 347 {
 348   if (types.empty()) {
 349     return true;
 350   }
 351
 352     std::vector<Type>::const_iterator it = types.begin(),
 353         end = types.end();
 354     for (; it != end; ++it) {
 355         return aPos->type() == *it;
 356     }
 357
 358     return false;
 359 }
 360