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 <string>
  25 #include <vector>
  26 #include <stdint.h>
  27
  28 #include <simgear/sg_inlines.h>
  29 #include <simgear/structure/SGSharedPtr.hxx>
  30 #include <simgear/math/SGMath.hxx>
  31
  32 class FGPositioned;
  33 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
  34
  35 typedef int64_t PositionedID;
  36 typedef std::vector<PositionedID> PositionedIDVec;
  37
  38 namespace flightgear { class NavDataCache; }
  39
  40 class FGPositioned : public SGReferenced
  41 {
  42 public:
  43
  44   typedef enum {
  45     INVALID = 0,
  46     AIRPORT,
  47     HELIPORT,
  48     SEAPORT,
  49     RUNWAY,
  50     HELIPAD,
  51     TAXIWAY,
  52     PAVEMENT,
  53     WAYPOINT,
  54     FIX,
  55     NDB,
  56     VOR,
  57     ILS,
  58     LOC,
  59     GS,
  60     OM,
  61     MM,
  62     IM,
  63 /// important that DME & TACAN are adjacent to keep the TacanFilter
  64 /// efficient - DMEs are proxies for TACAN/VORTAC stations
  65     DME,
  66     TACAN,
  67     MOBILE_TACAN,
  68     OBSTACLE,
  69 /// an actual airport tower - not a radio comms facility!
  70 /// some airports have multiple towers, eg EHAM, although our data source
  71 /// doesn't necessarily include them
  72     TOWER,
  73     FREQ_GROUND,
  74     FREQ_TOWER,
  75     FREQ_ATIS,
  76     FREQ_AWOS,
  77     FREQ_APP_DEP,
  78     FREQ_ENROUTE,
  79     FREQ_CLEARANCE,
  80     FREQ_UNICOM,
  81 // groundnet items
  82     PARKING,  ///< parking position - might be a gate, or stand
  83     TAXI_NODE,
  84     LAST_TYPE
  85   } Type;
  86
  87   typedef std::vector<FGPositionedRef> List;
  88
  89   virtual ~FGPositioned();
  90
  91   Type type() const
  92   { return mType; }
  93
  94   const std::string& ident() const
  95   { return mIdent; }
  96
  97   /**
  98    * Return the name of this positioned. By default this is the same as the
  99    * ident, but for many derived classes it's more meaningful - the aiport or
 100    * navaid name, for example.
 101    */
 102   virtual const std::string& name() const
 103   { return mIdent; }
 104
 105   const SGGeod& geod() const
 106   { return mPosition; }
 107
 108   PositionedID guid() const
 109   { return mGuid; }
 110
 111   /**
 112    *  The cartesian position associated with this object
 113    */
 114   const SGVec3d& cart() const;
 115
 116   double latitude() const
 117   { return mPosition.getLatitudeDeg(); }
 118
 119   double longitude() const
 120   { return mPosition.getLongitudeDeg(); }
 121
 122   double elevation() const
 123   { return mPosition.getElevationFt(); }
 124
 125   /**
 126    * Predicate class to support custom filtering of FGPositioned queries
 127    * Default implementation of this passes any FGPositioned instance.
 128    */
 129   class Filter
 130   {
 131   public:
 132     virtual ~Filter() { ; }
 133
 134     /**
 135      * Over-rideable filter method. Default implementation returns true.
 136      */
 137     virtual bool pass(FGPositioned* aPos) const
 138     { return true; }
 139
 140     virtual Type minType() const
 141     { return INVALID; }
 142
 143     virtual Type maxType() const
 144     { return INVALID; }
 145
 146
 147     bool operator()(FGPositioned* aPos) const
 148     { return pass(aPos); }
 149   };
 150
 151   class TypeFilter : public Filter
 152   {
 153   public:
 154     TypeFilter(Type aTy);
 155     virtual bool pass(FGPositioned* aPos) const;
 156
 157     virtual Type minType() const
 158     { return mMinType; }
 159
 160     virtual Type maxType() const
 161     { return mMaxType; }
 162
 163     void addType(Type aTy);
 164   private:
 165     std::vector<Type> types;
 166     Type mMinType, mMaxType;
 167   };
 168
 169   static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
 170
 171   static List findWithinRangePartial(const SGGeod& aPos, double aRangeNm, Filter* aFilter, bool& aPartial);
 172
 173   static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
 174
 175   static FGPositionedRef findFirstWithIdent(const std::string& aIdent, Filter* aFilter = NULL);
 176
 177   /**
 178    * Find all items with the specified ident
 179    * @param aFilter - optional filter on items
 180    */
 181   static List findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL, bool aExact = true);
 182
 183   /**
 184    * As above, but searches names instead of idents
 185    */
 186   static List findAllWithName(const std::string& aName, Filter* aFilter = NULL, bool aExact = true);
 187
 188   /**
 189    * Sort an FGPositionedList by distance from a position
 190    */
 191   static void sortByRange(List&, const SGGeod& aPos);
 192
 193   /**
 194    * Find the closest item to a position, which pass the specified filter
 195    * A cutoff range in NM must be specified, to constrain the search acceptably.
 196    * Very large cutoff values will make this slow.
 197    *
 198    * @result The closest item passing the filter, or NULL
 199    * @param aCutoffNm - maximum distance to search within, in nautical miles
 200    */
 201   static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
 202
 203   /**
 204    * Find the closest N items to a position, which pass the specified filter
 205    * A cutoff range in NM must be specified, to constrain the search acceptably.
 206    * Very large cutoff values will make this slow.
 207    *
 208    * @result The matches (possibly less than N, depending on the filter and cutoff),
 209    *    sorted by distance from the search pos
 210    * @param aN - number of matches to find
 211    * @param aCutoffNm - maximum distance to search within, in nautical miles
 212    */
 213   static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
 214
 215   /**
 216    * Same as above, but with a time-bound in msec too.
 217    */
 218   static List findClosestNPartial(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter,
 219                            bool& aPartial);
 220
 221   /**
 222    * Map a candidate type string to a real type. Returns INVALID if the string
 223    * does not correspond to a defined type.
 224    */
 225   static Type typeFromName(const std::string& aName);
 226
 227   /**
 228    * Map a type to a human-readable string
 229    */
 230   static const char* nameForType(Type aTy);
 231
 232   static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
 233 protected:
 234   friend class flightgear::NavDataCache;
 235
 236   FGPositioned(PositionedID aGuid, Type ty, const std::string& aIdent, const SGGeod& aPos);
 237
 238   void modifyPosition(const SGGeod& newPos);
 239
 240   const PositionedID mGuid;
 241   const SGGeod mPosition;
 242   const SGVec3d mCart;
 243   const Type mType;
 244   const std::string mIdent;
 245
 246 private:
 247   SG_DISABLE_COPY(FGPositioned);
 248 };
 249
 250 #endif // of FG_POSITIONED_HXX