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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 #ifndef _FG_ATCMGR_HXX
23 #define _FG_ATCMGR_HXX
25 #include <simgear/structure/subsystem_mgr.hxx>
27 #include <Main/fg_props.hxx>
35 #include "approach.hxx"
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.
57 //float approach_freq;
58 //bool approach_active;
59 //float departure_freq;
60 //bool departure_active;
62 // NOTE - the *_active flags determine whether the service is active in atc_list,
63 // *NOT* whether the tower etc is closed or not!!!!
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 unsigned int numAI; // Ref count of the number of AI planes registered
68 bool set_by_comm[2][ATC_NUM_TYPES]; // true when the relevant comm_freq has activated this station and type
71 class FGATCMgr : public SGSubsystem
76 bool initDone; // Hack - guard against update getting called before init
78 // A map of airport ID vs frequencies and ATC provision
79 typedef map < string, AirportATC* > airport_atc_map_type;
80 typedef airport_atc_map_type::iterator airport_atc_map_iterator;
81 typedef airport_atc_map_type::const_iterator airport_atc_map_const_iterator;
83 airport_atc_map_type airport_atc_map;
84 airport_atc_map_iterator airport_atc_map_itr;
86 // A list of pointers to all currently active ATC classes
87 typedef list <FGATC*> atc_list_type;
88 typedef atc_list_type::iterator atc_list_iterator;
89 typedef atc_list_type::const_iterator atc_list_const_iterator;
91 // Everything put in this list should be created dynamically
92 // on the heap and ***DELETED WHEN REMOVED!!!!!***
93 atc_list_type atc_list;
94 atc_list_iterator atc_list_itr;
95 // Any member function of FGATCMgr is permitted to leave this iterator pointing
96 // at any point in or at the end of the list.
97 // Hence any new access must explicitly first check for atc_list.end() before dereferencing.
99 // Position of the Users Aircraft
104 // Type of ATC control that the user's radios are tuned to.
105 atc_type comm_type[2];
107 // Pointer to the ATC station that the user is currently tuned into.
108 FGATC* comm_atc_ptr[2];
112 // Pointers to users current communication frequencies.
113 SGPropertyNode_ptr comm_node[2];
115 // Pointers to current users position
116 SGPropertyNode_ptr lon_node;
117 SGPropertyNode_ptr lat_node;
118 SGPropertyNode_ptr elev_node;
120 // Position of the ATC that the comm radios are tuned to in order to decide
121 // whether transmission will be received.
122 double comm_x[2], comm_y[2], comm_z[2], comm_lon[2], comm_lat[2], comm_elev[2];
124 double comm_range[2], comm_effective_range[2];
126 string comm_ident[2];
127 //string last_comm_ident[2];
128 //string approach_ident;
135 //FGDeparture departure;
137 // Voice related stuff
138 bool voice; // Flag - true if we are using voice
139 #ifdef ENABLE_AUDIO_SUPPORT
140 bool voiceOK; // Flag - true if at least one voice has loaded OK
155 void update(double dt);
157 // Returns true if the airport is found in the map
158 bool GetAirportATCDetails(const string& icao, AirportATC* a);
160 // Return a pointer to a given sort of ATC at a given airport and activate if necessary
161 // Returns NULL if service doesn't exist - calling function should check for this.
162 FGATC* GetATCPointer(const string& icao, const atc_type& type);
164 // Return a pointer to an appropriate voice for a given type of ATC
165 // creating the voice if necessary - ie. make sure exactly one copy
166 // of every voice in use exists in memory.
168 // TODO - in the future this will get more complex and dole out country/airport
169 // specific voices, and possible make sure that the same voice doesn't get used
170 // at different airports in quick succession if a large enough selection are available.
171 FGATCVoice* GetVoicePointer(const atc_type& type);
173 atc_type GetComm1ATCType() { return(comm_type[0]); }
174 FGATC* GetComm1ATCPointer() { return(comm_atc_ptr[0]); }
175 atc_type GetComm2ATCType() { return(comm_type[1]); }
176 FGATC* GetComm2ATCPointer() { return(comm_atc_ptr[1]); }
178 // Get the frequency of a given service at a given airport
179 // Returns zero if not found
180 unsigned short int GetFrequency(const string& ident, const atc_type& tp);
182 // Register the fact that the AI system wants to activate an airport
183 bool AIRegisterAirport(const string& ident);
185 // Register the fact that the comm radio is tuned to an airport
186 bool CommRegisterAirport(const string& ident, int chan, const atc_type& tp);
190 // Remove a class from the atc_list and delete it from memory
191 // *if* no other comm channel or AI plane is using it.
192 void CommRemoveFromList(const string& id, const atc_type& tp, int chan);
194 // Remove a class from the atc_list and delete it from memory
195 // Should be called from the above - not directly!!
196 void RemoveFromList(const string& id, const atc_type& tp);
198 // Return a pointer to a class in the list given ICAO code and type
199 // (external interface to this is through GetATCPointer)
200 // Return NULL if the given service is not in the list
201 // - *** THE CALLING FUNCTION MUST CHECK FOR THIS ***
202 FGATC* FindInList(const string& id, const atc_type& tp);
204 // Search the specified channel for stations on the same frequency and in range.
205 void FreqSearch(int channel);
207 // Search ATC stations by area in order that we appear 'on the radar'
212 #endif // _FG_ATCMGR_HXX