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/math/SGMath.hxx>
32 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
36 class PositionedBinding;
39 class FGPositioned : public SGReferenced
76 typedef std::vector<FGPositionedRef> List;
78 virtual ~FGPositioned();
83 const std::string& ident() const
87 * Return the name of this positioned. By default this is the same as the
88 * ident, but for many derived classes it's more meaningful - the aiport or
89 * navaid name, for example.
91 virtual const std::string& name() const
94 const SGGeod& geod() const
98 * The cartesian position associated with this object
100 const SGVec3d& cart() const;
102 double latitude() const
103 { return mPosition.getLatitudeDeg(); }
105 double longitude() const
106 { return mPosition.getLongitudeDeg(); }
108 double elevation() const
109 { return mPosition.getElevationFt(); }
112 virtual flightgear::PositionedBinding* createBinding(SGPropertyNode* nd) const;
115 * Predicate class to support custom filtering of FGPositioned queries
116 * Default implementation of this passes any FGPositioned instance.
121 virtual ~Filter() { ; }
124 * Over-rideable filter method. Default implementation returns true.
126 virtual bool pass(FGPositioned* aPos) const
129 virtual Type minType() const
132 virtual Type maxType() const
136 * Test if this filter has a non-empty type range
138 bool hasTypeRange() const;
141 * Assuming hasTypeRange is true, test if a given type passes the range
143 bool passType(Type aTy) const;
145 bool operator()(FGPositioned* aPos) const
146 { return pass(aPos); }
149 class TypeFilter : public Filter
152 TypeFilter(Type aTy);
153 virtual bool pass(FGPositioned* aPos) const;
154 void addType(Type aTy);
156 std::vector<Type> types;
159 static void installCommands();
161 static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
163 static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
166 * Find the next item with the specified partial ID, after the 'current' item
167 * Note this function is not hyper-efficient, particular where the partial id
168 * spans a large number of candidates.
170 * @param aCur - Current item, or NULL to retrieve the first item with partial id
171 * @param aId - the (partial) id to lookup
173 static FGPositionedRef findNextWithPartialId(FGPositionedRef aCur, const std::string& aId, Filter* aFilter = NULL);
176 * Find all items with the specified ident
177 * @param aFilter - optional filter on items
179 static List findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL, bool aExact = true);
182 * As above, but searches names instead of idents
184 static List findAllWithName(const std::string& aName, Filter* aFilter = NULL, bool aExact = true);
187 * Sort an FGPositionedList by distance from a position
189 static void sortByRange(List&, const SGGeod& aPos);
192 * Find the closest item to a position, which pass the specified filter
193 * A cutoff range in NM must be specified, to constrain the search acceptably.
194 * Very large cutoff values will make this slow.
196 * @result The closest item passing the filter, or NULL
197 * @param aCutoffNm - maximum distance to search within, in nautical miles
199 static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
202 * Find the closest N items to a position, which pass the specified filter
203 * A cutoff range in NM must be specified, to constrain the search acceptably.
204 * Very large cutoff values will make this slow.
206 * @result The matches (possibly less than N, depending on the filter and cutoff),
207 * sorted by distance from the search pos
208 * @param aN - number of matches to find
209 * @param aCutoffNm - maximum distance to search within, in nautical miles
211 static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
214 * Map a candidate type string to a real type. Returns INVALID if the string
215 * does not correspond to a defined type.
217 static Type typeFromName(const std::string& aName);
220 * Map a type to a human-readable string
222 static const char* nameForType(Type aTy);
224 static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
227 FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos);
229 void init(bool aIndexed);
231 // can't be const right now, navrecord at least needs to fix up the position
232 // after navaids are parsed
235 SGVec3d mCart; // once mPosition is const, this can be const too
237 const std::string mIdent;
240 #endif // of FG_POSITIONED_HXX