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>
40 // Structure for holding details of the ATC frequencies at a given airport, and whether they are in the active list or not.
41 // These can then be cross referenced with the commlists which are stored by frequency or bucket.
42 // Non-available services are denoted by a frequency of zero.
43 // These structures are only intended to be created for in-use airports, and removed when no longer needed.
52 class FGATCMgr : public SGSubsystem
57 bool initDone; // Hack - guard against update getting called before init
59 // A map of airport ID vs frequencies and ATC provision
60 typedef map < string, AirportATC* > airport_atc_map_type;
61 typedef airport_atc_map_type::iterator airport_atc_map_iterator;
62 typedef airport_atc_map_type::const_iterator airport_atc_map_const_iterator;
64 airport_atc_map_type airport_atc_map;
65 airport_atc_map_iterator airport_atc_map_itr;
67 // A list of pointers to all currently active ATC classes
68 typedef map<string,FGATC*> atc_list_type;
69 typedef atc_list_type::iterator atc_list_iterator;
70 typedef atc_list_type::const_iterator atc_list_const_iterator;
72 // Everything put in this list should be created dynamically
73 // on the heap and ***DELETED WHEN REMOVED!!!!!***
74 atc_list_type* atc_list;
75 atc_list_iterator atc_list_itr;
76 // Any member function of FGATCMgr is permitted to leave this iterator pointing
77 // at any point in or at the end of the list.
78 // Hence any new access must explicitly first check for atc_list.end() before dereferencing.
80 // Position of the Users Aircraft
83 // Pointers to current users position
84 SGPropertyNode_ptr lon_node;
85 SGPropertyNode_ptr lat_node;
86 SGPropertyNode_ptr elev_node;
90 // Voice related stuff
91 bool voice; // Flag - true if we are using voice
92 #ifdef ENABLE_AUDIO_SUPPORT
93 bool voiceOK; // Flag - true if at least one voice has loaded OK
108 void update(double dt);
110 // Returns true if the airport is found in the map
111 bool GetAirportATCDetails(const string& icao, AirportATC* a);
113 // Return a pointer to an appropriate voice for a given type of ATC
114 // creating the voice if necessary - ie. make sure exactly one copy
115 // of every voice in use exists in memory.
117 // TODO - in the future this will get more complex and dole out country/airport
118 // specific voices, and possible make sure that the same voice doesn't get used
119 // at different airports in quick succession if a large enough selection are available.
120 FGATCVoice* GetVoicePointer(const atc_type& type);
122 atc_type GetComm1ATCType() { return(INVALID/* kludge */); }
123 FGATC* GetComm1ATCPointer() { return(0/* kludge */); }
124 atc_type GetComm2ATCType() { return(INVALID); }
125 FGATC* GetComm2ATCPointer() { return(0/* kludge */); }
127 // Get the frequency of a given service at a given airport
128 // Returns zero if not found
129 unsigned short int GetFrequency(const string& ident, const atc_type& tp);
131 // Register the fact that the comm radio is tuned to an airport
132 bool CommRegisterAirport(const string& ident, int chan, const atc_type& tp);
136 // Remove a class from the atc_list and delete it from memory
137 // *if* no other comm channel or AI plane is using it.
138 void ZapOtherService(const string ncunit, const string svc_name);
140 // Return a pointer to a class in the list given ICAO code and type
141 // Return NULL if the given service is not in the list
142 // - *** THE CALLING FUNCTION MUST CHECK FOR THIS ***
143 FGATC* FindInList(const string& id, const atc_type& tp);
145 // Search the specified radio for stations on the same frequency and in range.
146 void FreqSearch(const string navcomm, const int unit);
149 #endif // _FG_ATCMGR_HXX