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   /**
  75    * Return the name of this positioned. By default this is the same as the
  76    * ident, but for many derived classes it's more meaningful - the aiport or
  77    * navaid name, for example.
  78    */
  79   virtual const std::string& name() const
  80   { return mIdent; }
  81
  82   const SGGeod& geod() const
  83   { return mPosition; }
  84
  85   /**
  86    * Compute the cartesian position associated with this object
  87    */
  88   SGVec3d cart() const;
  89
  90   SGBucket bucket() const;
  91
  92   double latitude() const
  93   { return mPosition.getLatitudeDeg(); }
  94
  95   double longitude() const
  96   { return mPosition.getLongitudeDeg(); }
  97
  98   double elevation() const
  99   { return mPosition.getElevationFt(); }
 100
 101   /**
 102    * Predicate class to support custom filtering of FGPositioned queries
 103    * Default implementation of this passes any FGPositioned instance.
 104    */
 105   class Filter
 106   {
 107   public:
 108     virtual ~Filter() { ; }
 109
 110     /**
 111      * Over-rideable filter method. Default implementation returns true.
 112      */
 113     virtual bool pass(FGPositioned* aPos) const
 114     { return true; }
 115
 116     virtual Type minType() const
 117     { return INVALID; }
 118
 119     virtual Type maxType() const
 120     { return INVALID; }
 121
 122     /**
 123      * Test if this filter has a non-empty type range
 124      */
 125     bool hasTypeRange() const;
 126
 127     /**
 128      * Assuming hasTypeRange is true, test if a given type passes the range
 129      */
 130     bool passType(Type aTy) const;
 131
 132     bool operator()(FGPositioned* aPos) const
 133     { return pass(aPos); }
 134   };
 135
 136   class TypeFilter : public Filter
 137   {
 138   public:
 139     TypeFilter(Type aTy) : mType(aTy) { ; }
 140     virtual bool pass(FGPositioned* aPos) const
 141     { return (mType == aPos->type()); }
 142   private:
 143     const Type mType;
 144   };
 145
 146   static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
 147
 148   static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
 149
 150   /**
 151    * Find the next item with the specified partial ID, after the 'current' item
 152    * Note this function is not hyper-efficient, particular where the partial id
 153    * spans a large number of candidates.
 154    *
 155    * @param aCur - Current item, or NULL to retrieve the first item with partial id
 156    * @param aId - the (partial) id to lookup
 157    */
 158   static FGPositionedRef findNextWithPartialId(FGPositionedRef aCur, const std::string& aId, Filter* aFilter = NULL);
 159
 160   /**
 161    * Find all items with the specified ident, and return then sorted by
 162    * distance from a position
 163    *
 164    * @param aFilter - optional filter on items
 165    */
 166   static List findAllWithIdentSortedByRange(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
 167
 168   /**
 169    * Find the closest item to a position, which pass the specified filter
 170    * A cutoff range in NM must be specified, to constrain the search acceptably.
 171    * Very large cutoff values will make this slow.
 172    *
 173    * @result The closest item passing the filter, or NULL
 174    * @param aCutoffNm - maximum distance to search within, in nautical miles
 175    */
 176   static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
 177
 178   /**
 179    * Find the closest N items to a position, which pass the specified filter
 180    * A cutoff range in NM must be specified, to constrain the search acceptably.
 181    * Very large cutoff values will make this slow.
 182    *
 183    * @result The matches (possibly less than N, depending on the filter and cutoff),
 184   *    sorted by distance from the search pos
 185    * @param aN - number of matches to find
 186    * @param aCutoffNm - maximum distance to search within, in nautical miles
 187    */
 188   static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
 189
 190
 191
 192   /**
 193    * Debug helper, map a type to a human-readable string
 194    */
 195   static const char* nameForType(Type aTy);
 196 protected:
 197
 198   FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos, bool aIndex = true);
 199
 200   // can't be const right now, navrecord at least needs to fix up the position
 201   // after navaids are parsed
 202   SGGeod mPosition;
 203
 204   const Type mType;
 205   const std::string mIdent;
 206 };
 207
 208 #endif // of FG_POSITIONED_HXX