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
27 #include <simgear/structure/SGSharedPtr.hxx>
28 #include <simgear/math/SGMath.hxx>
33 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
35 class FGPositioned : public SGReferenced
72 typedef std::vector<FGPositionedRef> List;
74 virtual ~FGPositioned();
79 const std::string& ident() const
83 * Return the name of this positioned. By default this is the same as the
84 * ident, but for many derived classes it's more meaningful - the aiport or
85 * navaid name, for example.
87 virtual const std::string& name() const
90 const SGGeod& geod() const
94 * The cartesian position associated with this object
96 const SGVec3d& cart() const;
98 double latitude() const
99 { return mPosition.getLatitudeDeg(); }
101 double longitude() const
102 { return mPosition.getLongitudeDeg(); }
104 double elevation() const
105 { return mPosition.getElevationFt(); }
108 * Predicate class to support custom filtering of FGPositioned queries
109 * Default implementation of this passes any FGPositioned instance.
114 virtual ~Filter() { ; }
117 * Over-rideable filter method. Default implementation returns true.
119 virtual bool pass(FGPositioned* aPos) const
122 virtual Type minType() const
125 virtual Type maxType() const
129 * Test if this filter has a non-empty type range
131 bool hasTypeRange() const;
134 * Assuming hasTypeRange is true, test if a given type passes the range
136 bool passType(Type aTy) const;
138 bool operator()(FGPositioned* aPos) const
139 { return pass(aPos); }
142 class TypeFilter : public Filter
145 TypeFilter(Type aTy);
146 virtual bool pass(FGPositioned* aPos) const;
147 void addType(Type aTy);
149 std::vector<Type> types;
152 static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
154 static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
157 * Find the next item with the specified partial ID, after the 'current' item
158 * Note this function is not hyper-efficient, particular where the partial id
159 * spans a large number of candidates.
161 * @param aCur - Current item, or NULL to retrieve the first item with partial id
162 * @param aId - the (partial) id to lookup
164 static FGPositionedRef findNextWithPartialId(FGPositionedRef aCur, const std::string& aId, Filter* aFilter = NULL);
167 * Find all items with the specified ident
168 * @param aFilter - optional filter on items
170 static List findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL, bool aExact = true);
173 * As above, but searches names instead of idents
175 static List findAllWithName(const std::string& aName, Filter* aFilter = NULL, bool aExact = true);
178 * Sort an FGPositionedList by distance from a position
180 static void sortByRange(List&, const SGGeod& aPos);
183 * Find the closest item to a position, which pass the specified filter
184 * A cutoff range in NM must be specified, to constrain the search acceptably.
185 * Very large cutoff values will make this slow.
187 * @result The closest item passing the filter, or NULL
188 * @param aCutoffNm - maximum distance to search within, in nautical miles
190 static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
193 * Find the closest N items to a position, which pass the specified filter
194 * A cutoff range in NM must be specified, to constrain the search acceptably.
195 * Very large cutoff values will make this slow.
197 * @result The matches (possibly less than N, depending on the filter and cutoff),
198 * sorted by distance from the search pos
199 * @param aN - number of matches to find
200 * @param aCutoffNm - maximum distance to search within, in nautical miles
202 static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
205 * Map a candidate type string to a real type. Returns INVALID if the string
206 * does not correspond to a defined type.
208 static Type typeFromName(const std::string& aName);
211 * Map a type to a human-readable string
213 static const char* nameForType(Type aTy);
215 static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
218 FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos);
220 void init(bool aIndexed);
222 // can't be const right now, navrecord at least needs to fix up the position
223 // after navaids are parsed
226 SGVec3d mCart; // once mPosition is const, this can be const too
228 const std::string mIdent;
231 #endif // of FG_POSITIONED_HXX