]> git.mxchange.org Git - flightgear.git/blobdiff - src/Navaids/positioned.hxx
Fix bug 1227, cache thrash on Win.
[flightgear.git] / src / Navaids / positioned.hxx
index d5f9b3672d135522fa7caaa818db1ecec4c7278b..8b4fb6a3f8c4b4c86e9816d9ed50677eb86efbb4 100644 (file)
 #ifndef FG_POSITIONED_HXX
 #define FG_POSITIONED_HXX
 
+#include <cassert>
+#include <string>
 #include <vector>
+#include <stdint.h>
 
+#include <simgear/sg_inlines.h>
 #include <simgear/structure/SGSharedPtr.hxx>
 #include <simgear/math/SGMath.hxx>
 
 class FGPositioned;
-
 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
+typedef std::vector<FGPositionedRef> FGPositionedList;
+
+typedef int64_t PositionedID;
+typedef std::vector<PositionedID> PositionedIDVec;
+
+namespace flightgear { class NavDataCache; }
 
 class FGPositioned : public SGReferenced
 {
@@ -40,35 +49,57 @@ public:
     HELIPORT,
     SEAPORT,
     RUNWAY,
+    HELIPAD,
     TAXIWAY,
     PAVEMENT,
-    PARK_STAND,
+    WAYPOINT,
     FIX,
-    VOR,
     NDB,
+    VOR,
     ILS,
     LOC,
     GS,
     OM,
     MM,
     IM,
+/// important that DME & TACAN are adjacent to keep the TacanFilter
+/// efficient - DMEs are proxies for TACAN/VORTAC stations
     DME,
     TACAN,
+    MOBILE_TACAN,
     OBSTACLE,
-    WAYPOINT, // user-defined waypoint
-    FREQ_GND,
-    FREQ_TWR,
+/// an actual airport tower - not a radio comms facility!
+/// some airports have multiple towers, eg EHAM, although our data source
+/// doesn't necessarily include them     
+    TOWER,
+    FREQ_GROUND,
+    FREQ_TOWER,
     FREQ_ATIS,
+    FREQ_AWOS,
+    FREQ_APP_DEP,
+    FREQ_ENROUTE,
+    FREQ_CLEARANCE,
+    FREQ_UNICOM,
+// groundnet items
+    PARKING,  ///< parking position - might be a gate, or stand
+    TAXI_NODE,
+// POI items
+    COUNTRY,
+    CITY,
+    TOWN,
+    VILLAGE,
+      
     LAST_TYPE
   } Type;
 
-  typedef std::vector<FGPositionedRef> List;
-  
   virtual ~FGPositioned();
   
   Type type() const
   { return mType; }
 
+  const char* typeString() const
+  { return nameForType(mType); }
+
   const std::string& ident() const
   { return mIdent; }
 
@@ -82,11 +113,14 @@ public:
 
   const SGGeod& geod() const
   { return mPosition; }
+  
+  PositionedID guid() const
+  { return mGuid; }
 
   /**
-   * Compute the cartesian position associated with this object
+   *  The cartesian position associated with this object
    */
-  SGVec3d cart() const;
+  const SGVec3d& cart() const;
 
   double latitude() const
   { return mPosition.getLatitudeDeg(); }
@@ -97,6 +131,9 @@ public:
   double elevation() const
   { return mPosition.getElevationFt(); }
   
+  double elevationM() const
+  { return mPosition.getElevationM(); }
+
   /**
    * Predicate class to support custom filtering of FGPositioned queries
    * Default implementation of this passes any FGPositioned instance.
@@ -118,15 +155,6 @@ public:
     virtual Type maxType() const
     { return INVALID; }
     
-    /**
-     * Test if this filter has a non-empty type range
-     */
-    bool hasTypeRange() const;
-    
-    /**
-     * Assuming hasTypeRange is true, test if a given type passes the range
-     */
-    bool passType(Type aTy) const;
     
     bool operator()(FGPositioned* aPos) const
     { return pass(aPos); }
@@ -135,49 +163,47 @@ public:
   class TypeFilter : public Filter
   {
   public:
-    TypeFilter(Type aTy) : mType(aTy) { ; }
-    virtual bool pass(FGPositioned* aPos) const
-    { return (mType == aPos->type()); }
+    TypeFilter(Type aTy = INVALID);
+    virtual bool pass(FGPositioned* aPos) const;
+    
+    virtual Type minType() const
+    { return mMinType; }
+    
+    virtual Type maxType() const
+    { return mMaxType; }
+    
+    void addType(Type aTy);
+      
+    static TypeFilter fromString(const std::string& aFilterSpec);
   private:
-    const Type mType;
+      
+    std::vector<Type> types;
+    Type mMinType, mMaxType;
   };
   
-  static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
+  static FGPositionedList findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
+  
+  static FGPositionedList findWithinRangePartial(const SGGeod& aPos, double aRangeNm, Filter* aFilter, bool& aPartial);
         
   static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
-  
-  /**
-   * Find the next item with the specified partial ID, after the 'current' item
-   * Note this function is not hyper-efficient, particular where the partial id
-   * spans a large number of candidates.
-   *
-   * @param aCur - Current item, or NULL to retrieve the first item with partial id
-   * @param aId - the (partial) id to lookup
-   */
-  static FGPositionedRef findNextWithPartialId(FGPositionedRef aCur, const std::string& aId, Filter* aFilter = NULL);
-  
-  /**
-   * As above, but searches using an offset index
-   */
-  static FGPositionedRef findWithPartialId(const std::string& aId, Filter* aFilter, int aOffset, bool& aNext);
+
+  static FGPositionedRef findFirstWithIdent(const std::string& aIdent, Filter* aFilter = NULL);
 
   /**
-   * As above, but search names instead of idents
+   * Find all items with the specified ident
+   * @param aFilter - optional filter on items
    */
-  static FGPositionedRef findWithPartialName(const std::string& aName, Filter* aFilter, int aOffset, bool& aNext);
+  static FGPositionedList findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL, bool aExact = true);
   
   /**
-   * Find all items with the specified ident, and return then sorted by
-   * distance from a position
-   *
-   * @param aFilter - optional filter on items
+   * As above, but searches names instead of idents
    */
-  static List findAllWithIdentSortedByRange(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
+  static FGPositionedList findAllWithName(const std::string& aName, Filter* aFilter = NULL, bool aExact = true);
   
   /**
-   * As above, but searches names instead of idents
+   * Sort an FGPositionedList by distance from a position
    */
-  static List findAllWithNameSortedByRange(const std::string& aName, const SGGeod& aPos, Filter* aFilter = NULL);
+  static void sortByRange(FGPositionedList&, const SGGeod& aPos);
   
   /**
    * Find the closest item to a position, which pass the specified filter
@@ -199,42 +225,68 @@ public:
    * @param aN - number of matches to find
    * @param aCutoffNm - maximum distance to search within, in nautical miles
    */
-  static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
-  
-  /**
-   * Find the closest match based on partial id (with an offset to allow selecting the n-th closest).
-   * Cutoff distance is limited internally, to avoid making this very slow.
-   */
-  static FGPositionedRef findClosestWithPartialId(const SGGeod& aPos, const std::string& aId, Filter* aFilter, int aOffset, bool& aNext);
-
+  static FGPositionedList findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
+    
   /**
-   * As above, but matches on name
+   * Same as above, but with a time-bound in msec too.
    */
-  static FGPositionedRef findClosestWithPartialName(const SGGeod& aPos, const std::string& aName, Filter* aFilter, int aOffset, bool& aNext);
-  
+  static FGPositionedList findClosestNPartial(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter,
+                           bool& aPartial);
   
+  template<class T>
+  static SGSharedPtr<T> loadById(PositionedID id)
+  {
+    return static_pointer_cast<T>( loadByIdImpl(id) );
+  }
+
+  template<class T>
+  static SGSharedPtr<T> loadById(const PositionedIDVec& id_vec, size_t index)
+  {
+    assert(index >= 0 && index < id_vec.size());
+    return loadById<T>(id_vec[index]);
+  }
+
+  template<class T>
+  static std::vector<SGSharedPtr<T> > loadAllById(const PositionedIDVec& id_vec)
+  {
+    std::vector<SGSharedPtr<T> > vec(id_vec.size());
+
+    for(size_t i = 0; i < id_vec.size(); ++i)
+      vec[i] = loadById<T>(id_vec[i]);
+
+    return vec;
+  }
+
   /**
    * Map a candidate type string to a real type. Returns INVALID if the string
    * does not correspond to a defined type.
    */
   static Type typeFromName(const std::string& aName);
-  
+
   /**
    * Map a type to a human-readable string
    */
   static const char* nameForType(Type aTy);
-  
+
   static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
+  static bool deleteUserWaypoint(const std::string& aIdent);
 protected:
-  
-  FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos, bool aIndex = true);
-  
-  // can't be const right now, navrecord at least needs to fix up the position
-  // after navaids are parsed
-  SGGeod mPosition; 
-  
+  friend class flightgear::NavDataCache;
+
+  FGPositioned(PositionedID aGuid, Type ty, const std::string& aIdent, const SGGeod& aPos);
+
+  void modifyPosition(const SGGeod& newPos);
+
+  static FGPositionedRef loadByIdImpl(PositionedID id);
+
+  const PositionedID mGuid;
+  const SGGeod mPosition;
+  const SGVec3d mCart;
   const Type mType;
   const std::string mIdent;
+  
+private:
+  SG_DISABLE_COPY(FGPositioned);
 };
 
 #endif // of FG_POSITIONED_HXX