src/Navaids/navlist.hxx

   1 // navlist.hxx -- navaids 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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_NAVLIST_HXX
  25 #define _FG_NAVLIST_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 "navrecord.hxx"
  36
  37 SG_USING_STD(map);
  38 SG_USING_STD(vector);
  39 SG_USING_STD(string);
  40
  41
  42 // convenience types
  43 typedef vector < FGNavRecord* > nav_list_type;
  44 typedef vector < FGTACANRecord* > tacan_list_type;
  45 typedef nav_list_type::iterator nav_list_iterator;
  46 typedef nav_list_type::const_iterator nav_list_const_iterator;
  47
  48 typedef map < int, nav_list_type > nav_map_type;
  49 typedef map < int, tacan_list_type > tacan_map_type;
  50 typedef nav_map_type::iterator nav_map_iterator;
  51 typedef nav_map_type::const_iterator nav_map_const_iterator;
  52
  53 typedef map < string, nav_list_type > nav_ident_map_type;
  54 typedef map < string, tacan_list_type > tacan_ident_map_type;
  55
  56 class FGNavList {
  57
  58     nav_list_type navlist;
  59     nav_list_type carrierlist;
  60     nav_map_type navaids;
  61     nav_map_type navaids_by_tile;
  62     nav_ident_map_type ident_navaids;
  63
  64     // Given a point and a list of stations, return the closest one to
  65     // the specified point.
  66     FGNavRecord *findNavFromList( const Point3D &aircraft,
  67                                   const nav_list_type &stations );
  68
  69 public:
  70
  71     FGNavList();
  72     ~FGNavList();
  73
  74     // initialize the nav list
  75     bool init();
  76
  77     // add an entry
  78     bool add( FGNavRecord *n );
  79     //bool add( FGTACANRecord *r );
  80
  81     /** Query the database for the specified station.  It is assumed
  82       * that there will be multiple stations with matching frequencies
  83       * so a position must be specified.  Lon and lat are in radians,
  84       * elev is in meters.
  85           */
  86     FGNavRecord *findByFreq( double freq, double lon, double lat, double elev );
  87
  88     // locate closest item in the DB matching the requested ident
  89     FGNavRecord *findByIdent( const char* ident, const double lon, const double lat );
  90
  91     // Given an Ident and optional freqency, return the first matching
  92     // station.
  93     FGNavRecord *findByIdentAndFreq( const char* ident,
  94                                      const double freq = 0.0 );
  95
  96     // returns the closest entry to the give lon/lat/elev
  97     FGNavRecord *findClosest( double lon_rad, double lat_rad, double elev_m );
  98
  99     // given a frequency returns the first matching entry
 100     FGNavRecord *findStationByFreq( double frequency );
 101
 102     inline const nav_map_type& get_navaids() const { return navaids; }
 103 };
 104
 105 class FGTACANList {
 106
 107     tacan_list_type channellist;
 108     //nav_list_type carrierlist;
 109     tacan_map_type channels;
 110     //nav_map_type navaids_by_tile;
 111     tacan_ident_map_type ident_channels;
 112
 113     // Given a point and a list of stations, return the closest one to
 114     // the specified point.
 115     /*FGNavRecord *findNavFromList( const Point3D &aircraft,
 116                                   const nav_list_type &stations );*/
 117
 118 public:
 119
 120     FGTACANList();
 121     ~FGTACANList();
 122
 123     // initialize the TACAN list
 124     bool init();
 125
 126     // add an entry
 127
 128     bool add( FGTACANRecord *r );
 129
 130     // Given a TACAN Channel, return the appropriate frequency.
 131     FGTACANRecord *findByChannel( const string& channel );
 132
 133
 134 };
 135 #endif // _FG_NAVLIST_HXX