#ifndef FG_POSITIONED_HXX
#define FG_POSITIONED_HXX
+#include <string>
#include <vector>
+#include <stdint.h>
+#include <simgear/sg_inlines.h>
#include <simgear/structure/SGSharedPtr.hxx>
-#include <simgear/bucket/newbucket.hxx>
+#include <simgear/math/SGMath.hxx>
class FGPositioned;
-
typedef SGSharedPtr<FGPositioned> FGPositionedRef;
+typedef int64_t PositionedID;
+typedef std::vector<PositionedID> PositionedIDVec;
+
+namespace flightgear { class NavDataCache; }
+
class FGPositioned : public SGReferenced
{
public:
SEAPORT,
RUNWAY,
TAXIWAY,
- PARK_STAND,
+ PAVEMENT,
+ 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,
LAST_TYPE
} Type;
const std::string& ident() const
{ return mIdent; }
+ /**
+ * Return the name of this positioned. By default this is the same as the
+ * ident, but for many derived classes it's more meaningful - the aiport or
+ * navaid name, for example.
+ */
+ virtual const std::string& name() const
+ { return mIdent; }
+
const SGGeod& geod() const
{ return mPosition; }
-
- SGBucket bucket() const;
+ PositionedID guid() const
+ { return mGuid; }
+
+ /**
+ * The cartesian position associated with this object
+ */
+ const SGVec3d& cart() const;
+
double latitude() const
{ return mPosition.getLatitudeDeg(); }
/**
* Predicate class to support custom filtering of FGPositioned queries
+ * Default implementation of this passes any FGPositioned instance.
*/
class Filter
{
public:
virtual ~Filter() { ; }
- virtual bool pass(FGPositioned* aPos) const = 0;
+ /**
+ * Over-rideable filter method. Default implementation returns true.
+ */
+ virtual bool pass(FGPositioned* aPos) const
+ { return true; }
+
+ virtual Type minType() const
+ { return INVALID; }
+
+ virtual Type maxType() const
+ { return INVALID; }
+
bool operator()(FGPositioned* aPos) const
{ return pass(aPos); }
};
- static List findWithinRange(const SGGeod& aPos, double aRangeNm, const Filter& aFilter);
-
- static List findWithinRangeByType(const SGGeod& aPos, double aRangeNm, Type aTy);
+ class TypeFilter : public Filter
+ {
+ public:
+ TypeFilter(Type aTy);
+ virtual bool pass(FGPositioned* aPos) const;
+
+ virtual Type minType() const
+ { return mMinType; }
+
+ virtual Type maxType() const
+ { return mMaxType; }
+
+ void addType(Type aTy);
+ private:
+ std::vector<Type> types;
+ Type mMinType, mMaxType;
+ };
+
+ static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
+
+ static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
+
+ static FGPositionedRef findFirstWithIdent(const std::string& aIdent, Filter* aFilter = NULL);
- static FGPositionedRef findClosestWithIdent(const std::string& aIdent, double aLat, double aLon);
+ /**
+ * Find all items with the specified ident
+ * @param aFilter - optional filter on items
+ */
+ static List findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL, bool aExact = true);
- static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos);
+ /**
+ * As above, but searches names instead of idents
+ */
+ static List findAllWithName(const std::string& aName, Filter* aFilter = NULL, bool aExact = true);
- static List findAllWithIdent(const std::string& aIdent);
+ /**
+ * Sort an FGPositionedList by distance from a position
+ */
+ static void sortByRange(List&, const SGGeod& aPos);
+
+ /**
+ * Find the closest item to a position, which pass the specified filter
+ * A cutoff range in NM must be specified, to constrain the search acceptably.
+ * Very large cutoff values will make this slow.
+ *
+ * @result The closest item passing the filter, or NULL
+ * @param aCutoffNm - maximum distance to search within, in nautical miles
+ */
+ static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
/**
* Find the closest N items to a position, which pass the specified filter
* Very large cutoff values will make this slow.
*
* @result The matches (possibly less than N, depending on the filter and cutoff),
- * sorted by distance from the search pos
+ * sorted by distance from the search pos
* @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, const Filter& aFilter);
+ static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
/**
- * Debug helper, map a type to a human-readable string
+ * 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);
-protected:
- FGPositioned(Type ty, const std::string& aIdent, double aLat, double aLon, double aElev);
- FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos);
+ static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
+protected:
+ friend class flightgear::NavDataCache;
- SGGeod mPosition; // can't be const right now
+ FGPositioned(PositionedID aGuid, Type ty, const std::string& aIdent, const SGGeod& aPos);
+
+ void modifyPosition(const SGGeod& newPos);
-//private: // make private once FGFix and FGRunway are heap-based
- FGPositioned();
+ const PositionedID mGuid;
+ const SGGeod mPosition;
+ const SGVec3d mCart;
+ const Type mType;
+ const std::string mIdent;
- Type mType;
- std::string mIdent;
+private:
+ SG_DISABLE_COPY(FGPositioned);
};
#endif // of FG_POSITIONED_HXX
projects / flightgear.git / blobdiff