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[2]; // true when the relevant comm_freq has activated this station
75 class FGATCMgr : public FGSubsystem
80 // A map of airport ID vs frequencies and ATC provision
81 typedef map < string, AirportATC* > airport_atc_map_type;
82 typedef airport_atc_map_type::iterator airport_atc_map_iterator;
83 typedef airport_atc_map_type::const_iterator airport_atc_map_const_iterator;
85 airport_atc_map_type airport_atc_map;
86 airport_atc_map_iterator airport_atc_map_itr;
88 // A list of pointers to all currently active ATC classes
89 typedef list <FGATC*> atc_list_type;
90 typedef atc_list_type::iterator atc_list_iterator;
91 typedef atc_list_type::const_iterator atc_list_const_iterator;
93 // Everything put in this list should be created dynamically
94 // on the heap and ***DELETED WHEN REMOVED!!!!!***
95 atc_list_type atc_list;
96 atc_list_iterator atc_list_itr;
97 // Any member function of FGATCMgr is permitted to leave this iterator pointing
98 // at any point in or at the end of the list.
99 // Hence any new access must explicitly first check for atc_list.end() before dereferencing.
101 // Position of the Users Aircraft
106 // Type of ATC control that the user's radios are tuned to.
107 atc_type comm_type[2];
109 // Pointer to the ATC station that the user is currently tuned into.
110 FGATC* comm_atc_ptr[2];
114 // Pointers to users current communication frequencies.
115 SGPropertyNode* comm_node[2];
117 // Pointers to current users position
118 SGPropertyNode* lon_node;
119 SGPropertyNode* lat_node;
120 SGPropertyNode* elev_node;
122 // Position of the ATC that the comm radios are tuned to in order to decide
123 // whether transmission will be received.
124 double comm_x[2], comm_y[2], comm_z[2], comm_lon[2], comm_lat[2], comm_elev[2];
126 double comm_range[2], comm_effective_range[2];
128 const char* comm_ident[2];
129 const char* last_comm_ident[2];
131 const char* approach_ident;
138 //FGDeparture departure;
140 // Voice related stuff
141 bool voice; // Flag - true if we are using voice
142 #ifdef ENABLE_AUDIO_SUPPORT
143 bool voiceOK; // Flag - true if at least one voice has loaded OK
158 void update(double dt);
160 // Returns true if the airport is found in the map
161 bool GetAirportATCDetails(string icao, AirportATC* a);
163 // Return a pointer to a given sort of ATC at a given airport and activate if necessary
164 // Returns NULL if service doesn't exist - calling function should check for this.
165 FGATC* GetATCPointer(string icao, atc_type type);
167 // Display a dialog box with options relevant to the currently tuned ATC service.
168 void doPopupDialog();
170 // Return a pointer to an appropriate voice for a given type of ATC
171 // creating the voice if necessary - ie. make sure exactly one copy
172 // of every voice in use exists in memory.
174 // TODO - in the future this will get more complex and dole out country/airport
175 // specific voices, and possible make sure that the same voice doesn't get used
176 // at different airports in quick succession if a large enough selection are available.
177 FGATCVoice* GetVoicePointer(atc_type type);
179 atc_type GetComm1ATCType() { return(comm_type[0]); }
180 FGATC* GetComm1ATCPointer() { return(comm_atc_ptr[0]); }
181 atc_type GetComm2ATCType() { return(comm_type[1]); }
182 FGATC* GetComm2ATCPointer() { return(comm_atc_ptr[1]); }
184 // Get the frequency of a given service at a given airport
185 // Returns zero if not found
186 unsigned short int GetFrequency(string ident, atc_type tp);
188 // Register the fact that the AI system wants to activate an airport
189 bool AIRegisterAirport(string ident);
191 // Register the fact that the comm radio is tuned to an airport
192 bool CommRegisterAirport(string ident, int chan);
196 // Remove a class from the atc_list and delete it from memory
197 // *if* no other comm channel or AI plane is using it.
198 void CommRemoveFromList(const char* id, atc_type tp, int chan);
200 // Remove a class from the atc_list and delete it from memory
201 // Should be called from the above - not directly!!
202 void RemoveFromList(const char* id, atc_type tp);
204 // Return a pointer to a class in the list given ICAO code and type
205 // (external interface to this is through GetATCPointer)
206 // Return NULL if the given service is not in the list
207 // - *** THE CALLING FUNCTION MUST CHECK FOR THIS ***
208 FGATC* FindInList(const char* id, atc_type tp);
210 // Search the specified channel for stations on the same frequency and in range.
211 void FreqSearch(int channel);
213 // Search ATC stations by area in order that we appear 'on the radar'
218 #endif // _FG_ATCMGR_HXX