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
86 * Compute the cartesian position associated with this object
90 SGBucket bucket() const;
92 double latitude() const
93 { return mPosition.getLatitudeDeg(); }
95 double longitude() const
96 { return mPosition.getLongitudeDeg(); }
98 double elevation() const
99 { return mPosition.getElevationFt(); }
102 * Predicate class to support custom filtering of FGPositioned queries
103 * Default implementation of this passes any FGPositioned instance.
108 virtual ~Filter() { ; }
111 * Over-rideable filter method. Default implementation returns true.
113 virtual bool pass(FGPositioned* aPos) const
116 virtual Type minType() const
119 virtual Type maxType() const
123 * Test if this filter has a non-empty type range
125 bool hasTypeRange() const;
128 * Assuming hasTypeRange is true, test if a given type passes the range
130 bool passType(Type aTy) const;
132 bool operator()(FGPositioned* aPos) const
133 { return pass(aPos); }
136 class TypeFilter : public Filter
139 TypeFilter(Type aTy) : mType(aTy) { ; }
140 virtual bool pass(FGPositioned* aPos) const
141 { return (mType == aPos->type()); }
146 static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
148 static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
151 * Find the next item with the specified partial ID, after the 'current' item
152 * Note this function is not hyper-efficient, particular where the partial id
153 * spans a large number of candidates.
155 * @param aCur - Current item, or NULL to retrieve the first item with partial id
156 * @param aId - the (partial) id to lookup
158 static FGPositionedRef findNextWithPartialId(FGPositionedRef aCur, const std::string& aId, Filter* aFilter = NULL);
161 * Find all items with the specified ident, and return then sorted by
162 * distance from a position
164 * @param aFilter - optional filter on items
166 static List findAllWithIdentSortedByRange(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
169 * Find the closest item to a position, which pass the specified filter
170 * A cutoff range in NM must be specified, to constrain the search acceptably.
171 * Very large cutoff values will make this slow.
173 * @result The closest item passing the filter, or NULL
174 * @param aCutoffNm - maximum distance to search within, in nautical miles
176 static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
179 * Find the closest N items to a position, which pass the specified filter
180 * A cutoff range in NM must be specified, to constrain the search acceptably.
181 * Very large cutoff values will make this slow.
183 * @result The matches (possibly less than N, depending on the filter and cutoff),
184 * sorted by distance from the search pos
185 * @param aN - number of matches to find
186 * @param aCutoffNm - maximum distance to search within, in nautical miles
188 static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
193 * Debug helper, map a type to a human-readable string
195 static const char* nameForType(Type aTy);
198 FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos, bool aIndex = true);
200 // can't be const right now, navrecord at least needs to fix up the position
201 // after navaids are parsed
205 const std::string mIdent;
208 #endif // of FG_POSITIONED_HXX