src/Navaids/positioned.hxx

   1 // positioned.hxx - 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 #ifndef FG_POSITIONED_HXX
  22 #define FG_POSITIONED_HXX
  23
  24 #include <vector>
  25
  26 #include <simgear/structure/SGSharedPtr.hxx>
  27 #include <simgear/bucket/newbucket.hxx>
  28
  29 class FGPositioned;
  30
  31 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
  32
  33 class FGPositioned : public SGReferenced
  34 {
  35 public:
  36
  37   typedef enum {
  38     INVALID = 0,
  39     AIRPORT,
  40     HELIPORT,
  41     SEAPORT,
  42     RUNWAY,
  43     TAXIWAY,
  44     PARK_STAND,
  45     FIX,
  46     VOR,
  47     NDB,
  48     ILS,
  49     LOC,
  50     GS,
  51     OM,
  52     MM,
  53     IM,
  54     DME,
  55     TACAN,
  56     OBSTACLE,
  57     WAYPOINT, // user-defined waypoint
  58     FREQ_GND,
  59     FREQ_TWR,
  60     FREQ_ATIS,
  61     LAST_TYPE
  62   } Type;
  63
  64   typedef std::vector<FGPositionedRef> List;
  65
  66   virtual ~FGPositioned();
  67
  68   Type type() const
  69   { return mType; }
  70
  71   const std::string& ident() const
  72   { return mIdent; }
  73
  74   const SGGeod& geod() const
  75   { return mPosition; }
  76
  77   SGBucket bucket() const;
  78
  79   double latitude() const
  80   { return mPosition.getLatitudeDeg(); }
  81
  82   double longitude() const
  83   { return mPosition.getLongitudeDeg(); }
  84
  85   double elevation() const
  86   { return mPosition.getElevationFt(); }
  87
  88   /**
  89    * Predicate class to support custom filtering of FGPositioned queries
  90    */
  91   class Filter
  92   {
  93   public:
  94     virtual ~Filter() { ; }
  95
  96     virtual bool pass(FGPositioned* aPos) const = 0;
  97
  98     bool operator()(FGPositioned* aPos) const
  99     { return pass(aPos); }
 100   };
 101
 102   static List findWithinRange(const SGGeod& aPos, double aRangeNm, const Filter& aFilter);
 103
 104   static List findWithinRangeByType(const SGGeod& aPos, double aRangeNm, Type aTy);
 105
 106   static FGPositionedRef findClosestWithIdent(const std::string& aIdent, double aLat, double aLon);
 107
 108   static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos);
 109
 110   static List findAllWithIdent(const std::string& aIdent);
 111
 112   /**
 113    * Find the closest N items to a position, which pass the specified filter
 114    * A cutoff range in NM must be specified, to constrain the search acceptably.
 115    * Very large cutoff values will make this slow.
 116    *
 117    * @result The matches (possibly less than N, depending on the filter and cutoff),
 118   *    sorted by distance from the search pos
 119    * @param aN - number of matches to find
 120    * @param aCutoffNm - maximum distance to search within, in nautical miles
 121    */
 122   static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, const Filter& aFilter);
 123
 124   /**
 125    * Debug helper, map a type to a human-readable string
 126    */
 127   static const char* nameForType(Type aTy);
 128 protected:
 129   FGPositioned(Type ty, const std::string& aIdent, double aLat, double aLon, double aElev);
 130
 131   FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos);
 132
 133   SGGeod mPosition; // can't be const right now
 134
 135 //private: // make private once FGFix and FGRunway are heap-based
 136   FGPositioned();
 137
 138   Type mType;
 139   std::string mIdent;
 140 };
 141
 142 #endif // of FG_POSITIONED_HXX