src/ATCDCL/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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22 #ifndef _FG_ATCMGR_HXX
  23 #define _FG_ATCMGR_HXX
  24
  25 #include <simgear/structure/subsystem_mgr.hxx>
  26
  27 #include <Main/fg_props.hxx>
  28 #include <GUI/gui.h>
  29
  30 #include <string>
  31 #include <list>
  32 #include <map>
  33
  34 #include "tower.hxx"
  35 #include "approach.hxx"
  36
  37 using std::string;
  38 using std::list;
  39 using std::map;
  40
  41 // Structure for holding details of the ATC frequencies at a given airport, and whether they are in the active list or not.
  42 // These can then be cross referenced with the commlists which are stored by frequency or bucket.
  43 // Non-available services are denoted by a frequency of zero.
  44 // These structures are only intended to be created for in-use airports, and removed when no longer needed.
  45 struct AirportATC {
  46         AirportATC();
  47
  48     SGGeod geod;
  49     float atis_freq;
  50     bool atis_active;
  51     float tower_freq;
  52     bool tower_active;
  53     float ground_freq;
  54     bool ground_active;
  55     //float approach_freq;
  56     //bool approach_active;
  57     //float departure_freq;
  58     //bool departure_active;
  59
  60         // NOTE - the *_active flags determine whether the service is active in atc_list,
  61         // *NOT* whether the tower etc is closed or not!!!!
  62
  63     // Flags to ensure the stations don't get wrongly deactivated
  64     bool set_by_AI;     // true when the AI manager has activated this station
  65         unsigned int numAI;     // Ref count of the number of AI planes registered
  66 //xx    bool set_by_comm[2][ATC_NUM_TYPES];     // true when the relevant comm_freq has activated this station and type
  67 };
  68
  69 class FGATCMgr : public SGSubsystem
  70 {
  71
  72 private:
  73
  74         bool initDone;  // Hack - guard against update getting called before init
  75
  76     // A map of airport ID vs frequencies and ATC provision
  77     typedef map < string, AirportATC* > airport_atc_map_type;
  78     typedef airport_atc_map_type::iterator airport_atc_map_iterator;
  79     typedef airport_atc_map_type::const_iterator airport_atc_map_const_iterator;
  80
  81     airport_atc_map_type airport_atc_map;
  82     airport_atc_map_iterator airport_atc_map_itr;
  83
  84     // A list of pointers to all currently active ATC classes
  85     typedef map<string,FGATC*> atc_list_type;
  86     typedef atc_list_type::iterator atc_list_iterator;
  87     typedef atc_list_type::const_iterator atc_list_const_iterator;
  88
  89     // Everything put in this list should be created dynamically
  90     // on the heap and ***DELETED WHEN REMOVED!!!!!***
  91     atc_list_type* atc_list;
  92     atc_list_iterator atc_list_itr;
  93     // Any member function of FGATCMgr is permitted to leave this iterator pointing
  94     // at any point in or at the end of the list.
  95     // Hence any new access must explicitly first check for atc_list.end() before dereferencing.
  96
  97     // Position of the Users Aircraft
  98     SGGeod _aircraftPos;
  99
 100     // Pointers to current users position
 101     SGPropertyNode_ptr lon_node;
 102     SGPropertyNode_ptr lat_node;
 103     SGPropertyNode_ptr elev_node;
 104
 105     //string approach_ident;
 106     bool last_in_range;
 107
 108     //FGATIS atis;
 109     //FGGround ground;
 110     FGTower tower;
 111     FGApproach approach;
 112     //FGDeparture departure;
 113
 114         // Voice related stuff
 115         bool voice;                     // Flag - true if we are using voice
 116 #ifdef ENABLE_AUDIO_SUPPORT
 117         bool voiceOK;           // Flag - true if at least one voice has loaded OK
 118         FGATCVoice* v1;
 119 #endif
 120
 121 public:
 122
 123     FGATCMgr();
 124     ~FGATCMgr();
 125
 126     void init();
 127
 128     void bind();
 129
 130     void unbind();
 131
 132     void update(double dt);
 133
 134     // Returns true if the airport is found in the map
 135     bool GetAirportATCDetails(const string& icao, AirportATC* a);
 136
 137     // Return a pointer to a given sort of ATC at a given airport and activate if necessary
 138         // Returns NULL if service doesn't exist - calling function should check for this.
 139     FGATC* GetATCPointer(const string& icao, const atc_type& type);
 140
 141         // Return a pointer to an appropriate voice for a given type of ATC
 142         // creating the voice if necessary - ie. make sure exactly one copy
 143         // of every voice in use exists in memory.
 144         //
 145         // TODO - in the future this will get more complex and dole out country/airport
 146         // specific voices, and possible make sure that the same voice doesn't get used
 147         // at different airports in quick succession if a large enough selection are available.
 148         FGATCVoice* GetVoicePointer(const atc_type& type);
 149
 150         atc_type GetComm1ATCType() { return(INVALID/* kludge */); }
 151         FGATC* GetComm1ATCPointer() { return(0/* kludge */); }
 152         atc_type GetComm2ATCType() { return(INVALID); }
 153         FGATC* GetComm2ATCPointer() { return(0/* kludge */); }
 154
 155         // Get the frequency of a given service at a given airport
 156         // Returns zero if not found
 157         unsigned short int GetFrequency(const string& ident, const atc_type& tp);
 158
 159         // Register the fact that the comm radio is tuned to an airport
 160         bool CommRegisterAirport(const string& ident, int chan, const atc_type& tp);
 161
 162 private:
 163
 164     // Remove a class from the atc_list and delete it from memory
 165         // *if* no other comm channel or AI plane is using it.
 166     void ZapOtherService(const string ncunit, const string svc_name);
 167
 168     // Return a pointer to a class in the list given ICAO code and type
 169         // (external interface to this is through GetATCPointer)
 170         // Return NULL if the given service is not in the list
 171         // - *** THE CALLING FUNCTION MUST CHECK FOR THIS ***
 172     FGATC* FindInList(const string& id, const atc_type& tp);
 173
 174     // Search the specified radio for stations on the same frequency and in range.
 175     void FreqSearch(const string navcomm, const int unit);
 176
 177 #ifdef AREA_SEARCH
 178     // Search ATC stations by area in order that we appear 'on the radar'
 179     void AreaSearch();
 180 #endif
 181
 182 };
 183
 184 #endif  // _FG_ATCMGR_HXX