src/ATC/ATCmgr.hxx

   1 // ATCMgr.hxx - definition of FGATCMgr
   2 // - a global management class for FlightGear generated ATC
   3 //
   4 // Written by David Luff, started February 2002.
   5 //
   6 // Copyright (C) 2002  David C Luff - david.luff@nottingham.ac.uk
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22 #ifndef _FG_ATCMGR_HXX
  23 #define _FG_ATCMGR_HXX
  24
  25 #include <Main/fgfs.hxx>
  26 #include <Main/fg_props.hxx>
  27 #include <Sound/soundmgr.hxx>
  28
  29 #include <string>
  30 #include <list>
  31 #include <map>
  32
  33 #include "atis.hxx"
  34 #include "tower.hxx"
  35 #include "approach.hxx"
  36 #include "ground.hxx"
  37 #include "ATC.hxx"
  38 #include "ATCVoice.hxx"
  39
  40 SG_USING_STD(string);
  41 SG_USING_STD(list);
  42 SG_USING_STD(map);
  43
  44 const int max_app = 20;
  45
  46 // Structure for holding details of the ATC frequencies at a given airport, and whether they are in the active list or not.
  47 // These can then be cross referenced with the [atis][tower][etc]lists which are stored by frequency.
  48 // Non-available services are denoted by a frequency of zero.
  49 // Eventually the whole ATC data structures may have to be rethought if we turn out to be massive memory hogs!!
  50 struct AirportATC {
  51     float lon;
  52     float lat;
  53     float elev;
  54     float atis_freq;
  55     bool atis_active;
  56     float tower_freq;
  57     bool tower_active;
  58     float ground_freq;
  59     bool ground_active;
  60     //float approach_freq;
  61     //bool approach_active;
  62     //float departure_freq;
  63     //bool departure_active;
  64
  65     // Flags to ensure the stations don't get wrongly deactivated
  66     bool set_by_AI;     // true when the AI manager has activated this station
  67     bool set_by_comm_search;    // true when the comm_search has activated this station
  68 };
  69
  70 class FGATCMgr : public FGSubsystem
  71 {
  72
  73 private:
  74
  75     // A map of airport ID vs frequencies and ATC provision
  76     typedef map < string, AirportATC* > airport_atc_map_type;
  77     typedef airport_atc_map_type::iterator airport_atc_map_iterator;
  78     typedef airport_atc_map_type::const_iterator airport_atc_map_const_iterator;
  79
  80     airport_atc_map_type airport_atc_map;
  81     airport_atc_map_iterator airport_atc_map_itr;
  82
  83     // A list of pointers to all currently active ATC classes
  84     typedef list <FGATC*> atc_list_type;
  85     typedef atc_list_type::iterator atc_list_iterator;
  86     typedef atc_list_type::const_iterator atc_list_const_iterator;
  87
  88     // Everything put in this list should be created dynamically
  89     // on the heap and ***DELETED WHEN REMOVED!!!!!***
  90     atc_list_type atc_list;
  91     atc_list_iterator atc_list_itr;
  92     // Any member function of FGATCMgr is permitted to leave this iterator pointing
  93     // at any point in or at the end of the list.
  94     // Hence any new access must explicitly first check for atc_list.end() before dereferencing.
  95
  96     // Position of the Users Aircraft
  97     double lon;
  98     double lat;
  99     double elev;
 100
 101     // Type of ATC control that the user's radios are tuned to.
 102     atc_type comm1_type;
 103     atc_type comm2_type;
 104
 105     double comm1_freq;
 106     double comm2_freq;
 107
 108     // Pointers to users current communication frequencies.
 109     SGPropertyNode* comm1_node;
 110     SGPropertyNode* comm2_node;
 111
 112     // Pointers to current users position
 113     SGPropertyNode* lon_node;
 114     SGPropertyNode* lat_node;
 115     SGPropertyNode* elev_node;
 116
 117     // Position of the ATC that the comm radios are tuned to in order to decide whether transmission
 118     // will be received
 119     double comm1_x, comm1_y, comm1_z, comm1_elev;
 120     double comm1_range, comm1_effective_range;
 121     bool comm1_valid;
 122     bool comm1_atis_valid;
 123     bool comm1_tower_valid;
 124     bool comm1_approach_valid;
 125     const char* comm1_ident;
 126     const char* comm1_atis_ident;
 127     const char* comm1_tower_ident;
 128     const char* comm1_approach_ident;
 129     const char* last_comm1_ident;
 130     const char* last_comm1_atis_ident;
 131     const char* last_comm1_tower_ident;
 132     const char* last_comm1_approach_ident;
 133     const char* approach_ident;
 134     bool last_in_range;
 135     double comm2_x, comm2_y, comm2_z, comm2_elev;
 136     double comm2_range, comm2_effective_range;
 137     bool comm2_valid;
 138     const char* comm2_ident;
 139     const char* last_comm2_ident;
 140
 141     FGATIS atis;
 142     //FGGround ground;
 143     FGTower tower;
 144     FGApproach approaches[max_app];
 145     FGApproach approach;
 146     //FGDeparture departure;
 147
 148         // Rendering related stuff
 149         bool voice;                     // Flag - true if we are using voice
 150         bool playing;           // Indicates a message in progress
 151 #ifdef ENABLE_AUDIO_SUPPORT
 152         string refname;         // FIXME - A hack - assumes only one sound to track.
 153         bool voiceOK;           // Flag - true if at least one voice has loaded OK
 154         FGATCVoice v1;
 155 #endif
 156
 157 public:
 158
 159     FGATCMgr();
 160     ~FGATCMgr();
 161
 162     void init();
 163
 164     void bind();
 165
 166     void unbind();
 167
 168     void update(double dt);
 169
 170     // Returns true if the airport is found in the map
 171     bool GetAirportATCDetails(string icao, AirportATC* a);
 172
 173     // Return a pointer to a given sort of ATC at a given airport and activate if necessary
 174     FGATC* GetATCPointer(string icao, atc_type type);
 175
 176         // Render a transmission
 177         // Outputs the transmission either on screen or as audio depending on user preference
 178         // The repeating flag indicates whether the message should be repeated continuously or played once.
 179         void Render(string msg, bool repeating);
 180
 181         // Cease rendering a transmission.
 182         // At the moment this can handle one transmission active at a time only.
 183         void NoRender();
 184
 185 private:
 186
 187     // Remove a class from the atc_list and delete it from memory
 188     void RemoveFromList(const char* id, atc_type tp);
 189
 190     // Return a pointer to a class in the list (external interface to this is through GetATCPointer)
 191     FGATC* FGATCMgr::FindInList(const char* id, atc_type tp);
 192
 193     // Search a specified freq for matching stations
 194     void Search();
 195
 196 };
 197
 198 #endif  // _FG_ATCMGR_HXX