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>
31 typedef SGSharedPtr<FGPositioned> FGPositionedRef;
33 class FGPositioned : public SGReferenced
58 WAYPOINT, // user-defined waypoint
65 typedef std::vector<FGPositionedRef> List;
67 virtual ~FGPositioned();
72 const std::string& ident() const
76 * Return the name of this positioned. By default this is the same as the
77 * ident, but for many derived classes it's more meaningful - the aiport or
78 * navaid name, for example.
80 virtual const std::string& name() const
83 const SGGeod& geod() const
87 * The cartesian position associated with this object
89 const SGVec3d& cart() const;
91 double latitude() const
92 { return mPosition.getLatitudeDeg(); }
94 double longitude() const
95 { return mPosition.getLongitudeDeg(); }
97 double elevation() const
98 { return mPosition.getElevationFt(); }
101 * Predicate class to support custom filtering of FGPositioned queries
102 * Default implementation of this passes any FGPositioned instance.
107 virtual ~Filter() { ; }
110 * Over-rideable filter method. Default implementation returns true.
112 virtual bool pass(FGPositioned* aPos) const
115 virtual Type minType() const
118 virtual Type maxType() const
122 * Test if this filter has a non-empty type range
124 bool hasTypeRange() const;
127 * Assuming hasTypeRange is true, test if a given type passes the range
129 bool passType(Type aTy) const;
131 bool operator()(FGPositioned* aPos) const
132 { return pass(aPos); }
135 class TypeFilter : public Filter
138 TypeFilter(Type aTy) : mType(aTy) { ; }
139 virtual bool pass(FGPositioned* aPos) const
140 { return (mType == aPos->type()); }
145 static List findWithinRange(const SGGeod& aPos, double aRangeNm, Filter* aFilter = NULL);
147 static FGPositionedRef findClosestWithIdent(const std::string& aIdent, const SGGeod& aPos, Filter* aFilter = NULL);
150 * Find the next item with the specified partial ID, after the 'current' item
151 * Note this function is not hyper-efficient, particular where the partial id
152 * spans a large number of candidates.
154 * @param aCur - Current item, or NULL to retrieve the first item with partial id
155 * @param aId - the (partial) id to lookup
157 static FGPositionedRef findNextWithPartialId(FGPositionedRef aCur, const std::string& aId, Filter* aFilter = NULL);
160 * Find all items with the specified ident
161 * @param aFilter - optional filter on items
163 static List findAllWithIdent(const std::string& aIdent, Filter* aFilter = NULL);
166 * As above, but searches names instead of idents
168 static List findAllWithName(const std::string& aName, Filter* aFilter = NULL);
171 * Sort an FGPositionedList by distance from a position
173 static void sortByRange(List&, const SGGeod& aPos);
176 * Find the closest item to a position, which pass the specified filter
177 * A cutoff range in NM must be specified, to constrain the search acceptably.
178 * Very large cutoff values will make this slow.
180 * @result The closest item passing the filter, or NULL
181 * @param aCutoffNm - maximum distance to search within, in nautical miles
183 static FGPositionedRef findClosest(const SGGeod& aPos, double aCutoffNm, Filter* aFilter = NULL);
186 * Find the closest N items to a position, which pass the specified filter
187 * A cutoff range in NM must be specified, to constrain the search acceptably.
188 * Very large cutoff values will make this slow.
190 * @result The matches (possibly less than N, depending on the filter and cutoff),
191 * sorted by distance from the search pos
192 * @param aN - number of matches to find
193 * @param aCutoffNm - maximum distance to search within, in nautical miles
195 static List findClosestN(const SGGeod& aPos, unsigned int aN, double aCutoffNm, Filter* aFilter = NULL);
198 * Map a candidate type string to a real type. Returns INVALID if the string
199 * does not correspond to a defined type.
201 static Type typeFromName(const std::string& aName);
204 * Map a type to a human-readable string
206 static const char* nameForType(Type aTy);
208 static FGPositioned* createUserWaypoint(const std::string& aIdent, const SGGeod& aPos);
211 FGPositioned(Type ty, const std::string& aIdent, const SGGeod& aPos);
213 void init(bool aIndexed);
215 // can't be const right now, navrecord at least needs to fix up the position
216 // after navaids are parsed
219 SGVec3d mCart; // once mPosition is const, this can be const too
221 const std::string mIdent;
224 #endif // of FG_POSITIONED_HXX