src/ATCDCL/ATCDialog.hxx

   1 // ATCDialog.hxx - Functions and classes to handle the pop-up ATC dialog
   2 //
   3 // Written by Alexander Kappes and David Luff, started February 2003.
   4 //
   5 // Copyright (C) 2003  Alexander Kappes and David Luff
   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 #ifndef ATC_DIALOG_HXX
  22 #define ATC_DIALOG_HXX
  23
  24 #include <simgear/compiler.h>
  25
  26 #include <vector>
  27 #include <map>
  28
  29 #include "ATC.hxx"
  30
  31 using std::vector;
  32 using std::map;
  33
  34 class NewGUI;
  35
  36 // ATCMenuEntry - an encapsulation of an entry in the ATC dialog
  37 struct ATCMenuEntry {
  38
  39   string  stationid;    // ID of transmitting station
  40   //int     stationfr;  // ?
  41   string  transmission; // Actual speech of transmission
  42   string  menuentry;    // Shortened version for display in the dialog
  43   int callback_code;    // This code is supplied by the registering station, and then
  44                         // returned to the registering station if that option is chosen.
  45                         // The actual value is only understood by the registering station -
  46                         // FGATCDialog only stores it and returns it if appropriate.
  47
  48   ATCMenuEntry();
  49   ~ATCMenuEntry();
  50 };
  51
  52 typedef vector < ATCMenuEntry > atcmentry_vec_type;
  53 typedef atcmentry_vec_type::iterator atcmentry_vec_iterator;
  54
  55 typedef map < string, atcmentry_vec_type > atcmentry_map_type;
  56 typedef atcmentry_map_type::iterator atcmentry_map_iterator;
  57
  58 //void ATCDialogInit();
  59
  60 //void ATCDoDialog(atc_type type);
  61
  62 class FGATCDialog {
  63
  64 public:
  65
  66         FGATCDialog();
  67         ~FGATCDialog();
  68
  69         void Init();
  70
  71         void Update(double dt);
  72
  73         void PopupDialog();
  74
  75         void PopupCallback(int);
  76
  77         void add_entry( const string& station, const string& transmission, const string& menutext, atc_type type, int code);
  78
  79         void remove_entry( const string &station, const string &trans, atc_type type );
  80
  81         void remove_entry( const string &station, int code, atc_type type );
  82
  83         // query the database whether the transmission is already registered;
  84         bool trans_reg( const string &station, const string &trans, atc_type type );
  85
  86         // query the database whether the transmission is already registered;
  87         bool trans_reg( const string &station, int code, atc_type type );
  88
  89         // Display a frequency search dialog for nearby stations
  90         void FreqDialog();
  91
  92         // Display the comm ATC frequencies for airport ident
  93         // where ident is a valid ICAO code.
  94         void FreqDisplay(string& ident);
  95
  96 private:
  97
  98         atcmentry_map_type available_dialog[ATC_NUM_TYPES];
  99
 100         int  freq;
 101         bool reset;
 102
 103         bool _callbackPending;
 104         double _callbackTimer;
 105         double _callbackWait;
 106         FGATC* _callbackPtr;
 107         int _callbackCode;
 108
 109         NewGUI *_gui;
 110 };
 111
 112 extern FGATCDialog *current_atcdialog;
 113
 114 #endif  // ATC_DIALOG_HXX
 115