1 // ATCMgr.hxx - definition of FGATCMgr
2 // - a global management class for FlightGear generated ATC
4 // Written by David Luff, started February 2002.
6 // Copyright (C) 2002 David C Luff - david.luff@nottingham.ac.uk
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.
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.
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.
22 #ifndef _FG_ATCMGR_HXX
23 #define _FG_ATCMGR_HXX
25 #include <Main/fgfs.hxx>
26 #include <Main/fg_props.hxx>
35 #include "approach.hxx"
38 #include "ATCVoice.hxx"
39 #include "transmissionlist.hxx"
45 // Structure for holding details of the ATC frequencies at a given airport, and whether they are in the active list or not.
46 // These can then be cross referenced with the commlists which are stored by frequency or bucket.
47 // Non-available services are denoted by a frequency of zero.
48 // These structures are only intended to be created for in-use airports, and removed when no longer needed.
61 //float approach_freq;
62 //bool approach_active;
63 //float departure_freq;
64 //bool departure_active;
66 // NOTE - the *_active flags determine whether the service is active in atc_list,
67 // *NOT* whether the tower etc is closed or not!!!!
69 // Flags to ensure the stations don't get wrongly deactivated
70 bool set_by_AI; // true when the AI manager has activated this station
71 unsigned int numAI; // Ref count of the number of AI planes registered
72 bool set_by_comm_search; // true when the comm_search has activated this station
73 // Do we need to distingiush comm1 and comm2?
76 class FGATCMgr : public FGSubsystem
81 // A map of airport ID vs frequencies and ATC provision
82 typedef map < string, AirportATC* > airport_atc_map_type;
83 typedef airport_atc_map_type::iterator airport_atc_map_iterator;
84 typedef airport_atc_map_type::const_iterator airport_atc_map_const_iterator;
86 airport_atc_map_type airport_atc_map;
87 airport_atc_map_iterator airport_atc_map_itr;
89 // A list of pointers to all currently active ATC classes
90 typedef list <FGATC*> atc_list_type;
91 typedef atc_list_type::iterator atc_list_iterator;
92 typedef atc_list_type::const_iterator atc_list_const_iterator;
94 // Everything put in this list should be created dynamically
95 // on the heap and ***DELETED WHEN REMOVED!!!!!***
96 atc_list_type atc_list;
97 atc_list_iterator atc_list_itr;
98 // Any member function of FGATCMgr is permitted to leave this iterator pointing
99 // at any point in or at the end of the list.
100 // Hence any new access must explicitly first check for atc_list.end() before dereferencing.
102 // Position of the Users Aircraft
107 // Type of ATC control that the user's radios are tuned to.
108 atc_type comm_type[2];
110 // Pointer to the ATC station that the user is currently tuned into.
111 FGATC* comm_atc_ptr[2];
115 // Pointers to users current communication frequencies.
116 SGPropertyNode* comm_node[2];
118 // Pointers to current users position
119 SGPropertyNode* lon_node;
120 SGPropertyNode* lat_node;
121 SGPropertyNode* elev_node;
123 // Position of the ATC that the comm radios are tuned to in order to decide
124 // whether transmission will be received.
125 double comm_x[2], comm_y[2], comm_z[2], comm_lon[2], comm_lat[2], comm_elev[2];
127 double comm_range[2], comm_effective_range[2];
129 const char* comm_ident[2];
130 const char* last_comm_ident[2];
132 const char* approach_ident;
139 //FGDeparture departure;
141 // Voice related stuff
142 bool voice; // Flag - true if we are using voice
143 #ifdef ENABLE_AUDIO_SUPPORT
144 bool voiceOK; // Flag - true if at least one voice has loaded OK
159 void update(double dt);
161 // Returns true if the airport is found in the map
162 bool GetAirportATCDetails(string icao, AirportATC* a);
164 // Return a pointer to a given sort of ATC at a given airport and activate if necessary
165 // Returns NULL if service doesn't exist - calling function should check for this.
166 FGATC* GetATCPointer(string icao, atc_type type);
168 // Display a dialog box with options relevant to the currently tuned ATC service.
169 void doPopupDialog();
171 // Return a pointer to an appropriate voice for a given type of ATC
172 // creating the voice if necessary - ie. make sure exactly one copy
173 // of every voice in use exists in memory.
175 // TODO - in the future this will get more complex and dole out country/airport
176 // specific voices, and possible make sure that the same voice doesn't get used
177 // at different airports in quick succession if a large enough selection are available.
178 FGATCVoice* GetVoicePointer(atc_type type);
180 atc_type GetComm1ATCType() { return(comm_type[0]); }
181 FGATC* GetComm1ATCPointer() { return(comm_atc_ptr[0]); }
182 atc_type GetComm2ATCType() { return(comm_type[1]); }
183 FGATC* GetComm2ATCPointer() { return(comm_atc_ptr[1]); }
185 // Get the frequency of a given service at a given airport
186 // Returns zero if not found
187 unsigned short int GetFrequency(string ident, atc_type tp);
189 // Register the fact that the AI system wants to activate an airport
190 bool AIRegisterAirport(string ident);
192 // Register the fact that the comm radio is tuned to an airport
193 bool CommRegisterAirport(string ident); // Later we'll differentiate between comm 1 and comm2
197 // Remove a class from the atc_list and delete it from memory
198 // *if* no other comm channel or AI plane is using it.
199 void CommRemoveFromList(const char* id, atc_type tp, int chan);
201 // Remove a class from the atc_list and delete it from memory
202 // Should be called from the above - not directly!!
203 void RemoveFromList(const char* id, atc_type tp);
205 // Return a pointer to a class in the list given ICAO code and type
206 // (external interface to this is through GetATCPointer)
207 // Return NULL if the given service is not in the list
208 // - *** THE CALLING FUNCTION MUST CHECK FOR THIS ***
209 FGATC* FindInList(const char* id, atc_type tp);
211 // Search the specified channel for stations on the same frequency and in range.
212 void FreqSearch(int channel);
214 // Search ATC stations by area in order that we appear 'on the radar'
219 #endif // _FG_ATCMGR_HXX