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
29 #include <simgear/sg_inlines.h>
30 #include <simgear/structure/SGSharedPtr.hxx>
31 #include <simgear/math/SGMath.hxx>
34 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
35 typedef std::vector<FGPositionedRef> FGPositionedList;
37 typedef int64_t PositionedID;
38 typedef std::vector<PositionedID> PositionedIDVec;
40 namespace flightgear { class NavDataCache; }
42 class FGPositioned : public SGReferenced
45 static const PositionedID TRANSIENT_ID;
66 /// important that DME & TACAN are adjacent to keep the TacanFilter
67 /// efficient - DMEs are proxies for TACAN/VORTAC stations
72 /// an actual airport tower - not a radio comms facility!
73 /// some airports have multiple towers, eg EHAM, although our data source
74 /// doesn't necessarily include them
85 PARKING, ///< parking position - might be a gate, or stand
96 virtual ~FGPositioned();
101 const char* typeString() const
102 { return nameForType(mType); }
104 const std::string& ident() const
108 * Return the name of this positioned. By default this is the same as the
109 * ident, but for many derived classes it's more meaningful - the aiport or
110 * navaid name, for example.
112 virtual const std::string& name() const
115 virtual const SGGeod& geod() const
116 { return mPosition; }
118 PositionedID guid() const
122 * The cartesian position associated with this object
124 virtual const SGVec3d& cart() const;
126 double latitude() const
127 { return geod().getLatitudeDeg(); }
129 double longitude() const
130 { return geod().getLongitudeDeg(); }
132 double elevation() const
133 { return geod().getElevationFt(); }
135 double elevationM() const
136 { return geod().getElevationM(); }
139 * Predicate class to support custom filtering of FGPositioned queries
140 * Default implementation of this passes any FGPositioned instance.
145 virtual ~Filter() { ; }
148 * Over-rideable filter method. Default implementation returns true.
150 virtual bool pass(FGPositioned* aPos) const
153 virtual Type minType() const
156 virtual Type maxType() const
160 bool operator()(FGPositioned* aPos) const
161 { return pass(aPos); }
164 class TypeFilter : public Filter
167 TypeFilter(Type aTy = INVALID);
168 virtual bool pass(FGPositioned* aPos) const;
170 virtual Type minType() const
173 virtual Type maxType() const
176 void addType(Type aTy);
178 static TypeFilter fromString(const std::string& aFilterSpec);
181 std::vector<Type> types;
182 Type mMinType, mMaxType;
185 static FGPositionedList findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter);
187 static FGPositionedList findWithinRangePartial(const SGGeod& aPos, double aRangeNm, Filter* aFilter, bool& aPartial);
189 static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
191 static FGPositionedRef findFirstWithIdent(const std::string& aIdent, Filter* aFilter);
194 * Find all items with the specified ident
195 * @param aFilter - optional filter on items
197 static FGPositionedList findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL, bool aExact = true);
200 * As above, but searches names instead of idents
202 static FGPositionedList findAllWithName(const std::string& aName, Filter* aFilter = NULL, bool aExact = true);
205 * Sort an FGPositionedList by distance from a position
207 static void sortByRange(FGPositionedList&, const SGGeod& aPos);
210 * Find the closest item to a position, which pass the specified filter
211 * A cutoff range in NM must be specified, to constrain the search acceptably.
212 * Very large cutoff values will make this slow.
214 * @result The closest item passing the filter, or NULL
215 * @param aCutoffNm - maximum distance to search within, in nautical miles
217 static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
220 * Find the closest N items to a position, which pass the specified filter
221 * A cutoff range in NM must be specified, to constrain the search acceptably.
222 * Very large cutoff values will make this slow.
224 * @result The matches (possibly less than N, depending on the filter and cutoff),
225 * sorted by distance from the search pos
226 * @param aN - number of matches to find
227 * @param aCutoffNm - maximum distance to search within, in nautical miles
229 static FGPositionedList findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
232 * Same as above, but with a time-bound in msec too.
234 static FGPositionedList findClosestNPartial(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter,
238 static SGSharedPtr<T> loadById(PositionedID id)
240 return static_pointer_cast<T>( loadByIdImpl(id) );
244 static SGSharedPtr<T> loadById(const PositionedIDVec& id_vec, size_t index)
246 assert(index >= 0 && index < id_vec.size());
247 return loadById<T>(id_vec[index]);
251 static std::vector<SGSharedPtr<T> > loadAllById(const PositionedIDVec& id_vec)
253 std::vector<SGSharedPtr<T> > vec(id_vec.size());
255 for(size_t i = 0; i < id_vec.size(); ++i)
256 vec[i] = loadById<T>(id_vec[i]);
262 * Map a candidate type string to a real type. Returns INVALID if the string
263 * does not correspond to a defined type.
265 static Type typeFromName(const std::string& aName);
268 * Map a type to a human-readable string
270 static const char* nameForType(Type aTy);
272 static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
273 static bool deleteUserWaypoint(const std::string& aIdent);
275 friend class flightgear::NavDataCache;
277 FGPositioned(PositionedID aGuid, Type ty, const std::string& aIdent, const SGGeod& aPos);
279 void modifyPosition(const SGGeod& newPos);
280 void invalidatePosition();
282 static FGPositionedRef loadByIdImpl(PositionedID id);
284 const PositionedID mGuid;
286 const std::string mIdent;
289 SG_DISABLE_COPY(FGPositioned);
291 const SGGeod mPosition;
295 #endif // of FG_POSITIONED_HXX