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
26 #include <simgear/structure/SGSharedPtr.hxx>
27 #include <simgear/bucket/newbucket.hxx>
31 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
33 class FGPositioned : public SGReferenced
57 WAYPOINT, // user-defined waypoint
64 typedef std::vector<FGPositionedRef> List;
66 virtual ~FGPositioned();
71 const std::string& ident() const
75 * Return the name of this positioned. By default this is the same as the
76 * ident, but for many derived classes it's more meaningful - the aiport or
77 * navaid name, for example.
79 virtual const std::string& name() const
82 const SGGeod& geod() const
85 SGBucket bucket() const;
87 double latitude() const
88 { return mPosition.getLatitudeDeg(); }
90 double longitude() const
91 { return mPosition.getLongitudeDeg(); }
93 double elevation() const
94 { return mPosition.getElevationFt(); }
97 * Predicate class to support custom filtering of FGPositioned queries
98 * Default implementation of this passes any FGPositioned instance.
103 virtual ~Filter() { ; }
106 * Over-rideable filter method. Default implementation returns true.
108 virtual bool pass(FGPositioned* aPos) const
111 bool operator()(FGPositioned* aPos) const
112 { return pass(aPos); }
115 class TypeFilter : public Filter
118 TypeFilter(Type aTy) : mType(aTy) { ; }
119 virtual bool pass(FGPositioned* aPos) const
120 { return (mType == aPos->type()); }
125 static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
127 static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
130 * Find the next item with the specified partial ID, after the 'current' item
131 * Note this function is not hyper-efficient, particular where the partial id
132 * spans a large number of candidates.
134 * @param aCur - Current item, or NULL to retrieve the first item with partial id
135 * @param aId - the (partial) id to lookup
137 static FGPositionedRef findNextWithPartialId(FGPositionedRef aCur, const std::string& aId, Filter* aFilter = NULL);
140 * Find all items with the specified ident, and return then sorted by
141 * distance from a position
143 * @param aFilter - optional filter on items
145 static List findAllWithIdentSortedByRange(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
148 * Find the closest item to a position, which pass the specified filter
149 * A cutoff range in NM must be specified, to constrain the search acceptably.
150 * Very large cutoff values will make this slow.
152 * @result The closest item passing the filter, or NULL
153 * @param aCutoffNm - maximum distance to search within, in nautical miles
155 static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
158 * Find the closest N items to a position, which pass the specified filter
159 * A cutoff range in NM must be specified, to constrain the search acceptably.
160 * Very large cutoff values will make this slow.
162 * @result The matches (possibly less than N, depending on the filter and cutoff),
163 * sorted by distance from the search pos
164 * @param aN - number of matches to find
165 * @param aCutoffNm - maximum distance to search within, in nautical miles
167 static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
172 * Debug helper, map a type to a human-readable string
174 static const char* nameForType(Type aTy);
177 FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos, bool aIndex = true);
179 // can't be const right now, navrecord at least needs to fix up the position
180 // after navaids are parsed
184 const std::string mIdent;
187 #endif // of FG_POSITIONED_HXX