#ifndef _FG_ATCMGR_HXX
#define _FG_ATCMGR_HXX
-#include <Main/fgfs.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
+
#include <Main/fg_props.hxx>
+#include <GUI/gui.h>
+#include <string>
#include <list>
+#include <map>
#include "atis.hxx"
+#include "tower.hxx"
+#include "approach.hxx"
+#include "ground.hxx"
#include "ATC.hxx"
+#include "ATCVoice.hxx"
+#include "transmissionlist.hxx"
+SG_USING_STD(string);
SG_USING_STD(list);
+SG_USING_STD(map);
+
+// Structure for holding details of the ATC frequencies at a given airport, and whether they are in the active list or not.
+// These can then be cross referenced with the commlists which are stored by frequency or bucket.
+// Non-available services are denoted by a frequency of zero.
+// These structures are only intended to be created for in-use airports, and removed when no longer needed.
+struct AirportATC {
+ AirportATC();
+
+ float lon;
+ float lat;
+ float elev;
+ float atis_freq;
+ bool atis_active;
+ float tower_freq;
+ bool tower_active;
+ float ground_freq;
+ bool ground_active;
+ //float approach_freq;
+ //bool approach_active;
+ //float departure_freq;
+ //bool departure_active;
+
+ // NOTE - the *_active flags determine whether the service is active in atc_list,
+ // *NOT* whether the tower etc is closed or not!!!!
+
+ // Flags to ensure the stations don't get wrongly deactivated
+ bool set_by_AI; // true when the AI manager has activated this station
+ unsigned int numAI; // Ref count of the number of AI planes registered
+ bool set_by_comm[2][ATC_NUM_TYPES]; // true when the relevant comm_freq has activated this station and type
+};
-class FGATCMgr : public FGSubsystem
+class FGATCMgr : public SGSubsystem
{
private:
+ bool initDone; // Hack - guard against update getting called before init
+
+ // A map of airport ID vs frequencies and ATC provision
+ typedef map < string, AirportATC* > airport_atc_map_type;
+ typedef airport_atc_map_type::iterator airport_atc_map_iterator;
+ typedef airport_atc_map_type::const_iterator airport_atc_map_const_iterator;
+
+ airport_atc_map_type airport_atc_map;
+ airport_atc_map_iterator airport_atc_map_itr;
+
// A list of pointers to all currently active ATC classes
typedef list <FGATC*> atc_list_type;
typedef atc_list_type::iterator atc_list_iterator;
double lat;
double elev;
- atc_type comm1_type;
- atc_type comm2_type;
+ // Type of ATC control that the user's radios are tuned to.
+ atc_type comm_type[2];
+
+ // Pointer to the ATC station that the user is currently tuned into.
+ FGATC* comm_atc_ptr[2];
- double comm1_freq;
- double comm2_freq;
+ double comm_freq[2];
// Pointers to users current communication frequencies.
- SGPropertyNode *comm1_node;
- SGPropertyNode *comm2_node;
+ SGPropertyNode* comm_node[2];
// Pointers to current users position
- SGPropertyNode *lon_node;
- SGPropertyNode *lat_node;
- SGPropertyNode *elev_node;
-
- // Position of the ATC that the comm radios are tuned to in order to decide whether transmission
- // will be received
- double comm1_x, comm1_y, comm1_z, comm1_elev;
- double comm1_range, comm1_effective_range;
- bool comm1_valid;
- const char* comm1_ident;
- const char* last_comm1_ident;
- double comm2_x, comm2_y, comm2_z, comm2_elev;
- double comm2_range, comm2_effective_range;
- bool comm2_valid;
- const char* comm2_ident;
- const char* last_comm2_ident;
-
- FGATIS atis;
- //FGTower tower;
+ SGPropertyNode* lon_node;
+ SGPropertyNode* lat_node;
+ SGPropertyNode* elev_node;
+
+ // Position of the ATC that the comm radios are tuned to in order to decide
+ // whether transmission will be received.
+ double comm_x[2], comm_y[2], comm_z[2], comm_lon[2], comm_lat[2], comm_elev[2];
+
+ double comm_range[2], comm_effective_range[2];
+ bool comm_valid[2];
+ string comm_ident[2];
+ //string last_comm_ident[2];
+ //string approach_ident;
+ bool last_in_range;
+
+ //FGATIS atis;
//FGGround ground;
- //FGApproach approach;
+ FGTower tower;
+ FGApproach approach;
//FGDeparture departure;
+
+ // Voice related stuff
+ bool voice; // Flag - true if we are using voice
+#ifdef ENABLE_AUDIO_SUPPORT
+ bool voiceOK; // Flag - true if at least one voice has loaded OK
+ FGATCVoice* v1;
+#endif
public:
void unbind();
- void update(int dt);
-
+ void update(double dt);
+
+ // Returns true if the airport is found in the map
+ bool GetAirportATCDetails(const string& icao, AirportATC* a);
+
+ // Return a pointer to a given sort of ATC at a given airport and activate if necessary
+ // Returns NULL if service doesn't exist - calling function should check for this.
+ FGATC* GetATCPointer(const string& icao, const atc_type& type);
+
+ // Return a pointer to an appropriate voice for a given type of ATC
+ // creating the voice if necessary - ie. make sure exactly one copy
+ // of every voice in use exists in memory.
+ //
+ // TODO - in the future this will get more complex and dole out country/airport
+ // specific voices, and possible make sure that the same voice doesn't get used
+ // at different airports in quick succession if a large enough selection are available.
+ FGATCVoice* GetVoicePointer(const atc_type& type);
+
+ atc_type GetComm1ATCType() { return(comm_type[0]); }
+ FGATC* GetComm1ATCPointer() { return(comm_atc_ptr[0]); }
+ atc_type GetComm2ATCType() { return(comm_type[1]); }
+ FGATC* GetComm2ATCPointer() { return(comm_atc_ptr[1]); }
+
+ // Get the frequency of a given service at a given airport
+ // Returns zero if not found
+ unsigned short int GetFrequency(const string& ident, const atc_type& tp);
+
+ // Register the fact that the AI system wants to activate an airport
+ bool AIRegisterAirport(const string& ident);
+
+ // Register the fact that the comm radio is tuned to an airport
+ bool CommRegisterAirport(const string& ident, int chan, const atc_type& tp);
+
private:
// Remove a class from the atc_list and delete it from memory
- void RemoveFromList(const char* id, atc_type tp);
+ // *if* no other comm channel or AI plane is using it.
+ void CommRemoveFromList(const string& id, const atc_type& tp, int chan);
- // Search a specified freq for matching stations
- void Search();
+ // Remove a class from the atc_list and delete it from memory
+ // Should be called from the above - not directly!!
+ void RemoveFromList(const string& id, const atc_type& tp);
+
+ // Return a pointer to a class in the list given ICAO code and type
+ // (external interface to this is through GetATCPointer)
+ // Return NULL if the given service is not in the list
+ // - *** THE CALLING FUNCTION MUST CHECK FOR THIS ***
+ FGATC* FindInList(const string& id, const atc_type& tp);
+
+ // Search the specified channel for stations on the same frequency and in range.
+ void FreqSearch(int channel);
+
+ // Search ATC stations by area in order that we appear 'on the radar'
+ void AreaSearch();
};