src/Navaids/fixlist.hxx

   1 // fixlist.hxx -- fix list management class
   2 //
   3 // Written by Curtis Olson, started April 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson - http://www.flightgear.org/~curt
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_FIXLIST_HXX
  25 #define _FG_FIXLIST_HXX
  26
  27
  28 #include <simgear/compiler.h>
  29 #include <simgear/misc/sg_path.hxx>
  30
  31 #include <map>
  32 #include <vector>
  33 #include STL_STRING
  34
  35 #include "fix.hxx"
  36
  37 SG_USING_STD(map);
  38 SG_USING_STD(vector);
  39 SG_USING_STD(string);
  40
  41 // TODO - fix names may be globally non-unique.  Allow for this.
  42 typedef map < string, FGFix > fix_map_type;
  43 typedef fix_map_type::iterator fix_map_iterator;
  44 typedef fix_map_type::const_iterator fix_map_const_iterator;
  45
  46 class FGFixList {
  47
  48     fix_map_type fixlist;
  49
  50 public:
  51
  52     FGFixList();
  53     ~FGFixList();
  54
  55     // load the navaids and build the map
  56     bool init( SGPath path );
  57
  58     // query the database for the specified fix
  59     bool query( const string& ident, FGFix *f );
  60
  61     // Find fix of requested type with closest exact or following ident
  62     // (by ACSII values) to that supplied (ie. a lower-bound lookup).
  63     // Supplying true for exact forces only exact matches to be returned (similar to above function)
  64     // Returns NULL if no match found.
  65     const FGFix* findFirstByIdent( const string& ident, bool exact = false );
  66
  67     // query the database for the specified fix, lon and lat are
  68     // in degrees, elev is in meters
  69     bool query_and_offset( const string& ident, double lon, double lat,
  70                            double elev, FGFix *f, double *heading,
  71                            double *dist );
  72
  73     // Return a pointer to the master fixlist
  74     inline const fix_map_type* getFixList() { return(&fixlist); }
  75 };
  76
  77
  78 #endif // _FG_FIXLIST_HXX