1 // positioned.hxx - base class for objects which are positioned
3 // Copyright (C) 2008 James Turner
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.
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.
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.
21 #ifndef FG_POSITIONED_HXX
22 #define FG_POSITIONED_HXX
28 #include <simgear/structure/SGSharedPtr.hxx>
29 #include <simgear/math/SGMath.hxx>
32 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
34 typedef int64_t PositionedID;
35 typedef std::vector<PositionedID> PositionedIDVec;
37 namespace flightgear { class NavDataCache; }
39 class FGPositioned : public SGReferenced
62 /// important that DME & TACAN are adjacent to keep the TacanFilter
63 /// efficient - DMEs are proxies for TACAN/VORTAC stations
68 /// an actual airport tower - not a radio comms facility!
69 /// some airports have multiple towers, eg EHAM, although our data source
70 /// doesn't necessarily include them
83 typedef std::vector<FGPositionedRef> List;
85 virtual ~FGPositioned();
90 const std::string& ident() const
94 * Return the name of this positioned. By default this is the same as the
95 * ident, but for many derived classes it's more meaningful - the aiport or
96 * navaid name, for example.
98 virtual const std::string& name() const
101 const SGGeod& geod() const
102 { return mPosition; }
104 PositionedID guid() const
108 * The cartesian position associated with this object
110 const SGVec3d& cart() const;
112 double latitude() const
113 { return mPosition.getLatitudeDeg(); }
115 double longitude() const
116 { return mPosition.getLongitudeDeg(); }
118 double elevation() const
119 { return mPosition.getElevationFt(); }
122 * Predicate class to support custom filtering of FGPositioned queries
123 * Default implementation of this passes any FGPositioned instance.
128 virtual ~Filter() { ; }
131 * Over-rideable filter method. Default implementation returns true.
133 virtual bool pass(FGPositioned* aPos) const
136 virtual Type minType() const
139 virtual Type maxType() const
143 bool operator()(FGPositioned* aPos) const
144 { return pass(aPos); }
147 class TypeFilter : public Filter
150 TypeFilter(Type aTy);
151 virtual bool pass(FGPositioned* aPos) const;
153 virtual Type minType() const
156 virtual Type maxType() const
159 void addType(Type aTy);
161 std::vector<Type> types;
162 Type mMinType, mMaxType;
165 static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
167 static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
169 static FGPositionedRef findFirstWithIdent(const std::string& aIdent, Filter* aFilter = NULL);
172 * Find all items with the specified ident
173 * @param aFilter - optional filter on items
175 static List findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL, bool aExact = true);
178 * As above, but searches names instead of idents
180 static List findAllWithName(const std::string& aName, Filter* aFilter = NULL, bool aExact = true);
183 * Sort an FGPositionedList by distance from a position
185 static void sortByRange(List&, const SGGeod& aPos);
188 * Find the closest item to a position, which pass the specified filter
189 * A cutoff range in NM must be specified, to constrain the search acceptably.
190 * Very large cutoff values will make this slow.
192 * @result The closest item passing the filter, or NULL
193 * @param aCutoffNm - maximum distance to search within, in nautical miles
195 static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
198 * Find the closest N items to a position, which pass the specified filter
199 * A cutoff range in NM must be specified, to constrain the search acceptably.
200 * Very large cutoff values will make this slow.
202 * @result The matches (possibly less than N, depending on the filter and cutoff),
203 * sorted by distance from the search pos
204 * @param aN - number of matches to find
205 * @param aCutoffNm - maximum distance to search within, in nautical miles
207 static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
210 * Map a candidate type string to a real type. Returns INVALID if the string
211 * does not correspond to a defined type.
213 static Type typeFromName(const std::string& aName);
216 * Map a type to a human-readable string
218 static const char* nameForType(Type aTy);
220 static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
222 friend class flightgear::NavDataCache;
224 FGPositioned(PositionedID aGuid, Type ty, const std::string& aIdent, const SGGeod& aPos);
226 void modifyPosition(const SGGeod& newPos);
228 const PositionedID mGuid;
229 const SGGeod mPosition;
232 const std::string mIdent;
235 #endif // of FG_POSITIONED_HXX