//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
-// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#ifndef _FG_ATCMGR_HXX
#define _FG_ATCMGR_HXX
-#include <Main/fgfs.hxx>
+#include <simgear/structure/subsystem_mgr.hxx>
+
#include <Main/fg_props.hxx>
-#include <Sound/soundmgr.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"
SG_USING_STD(string);
SG_USING_STD(list);
SG_USING_STD(map);
-const int max_app = 20;
-
// 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 [atis][tower][etc]lists which are stored by frequency.
+// 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.
-// Eventually the whole ATC data structures may have to be rethought if we turn out to be massive memory hogs!!
+// 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;
//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
- bool set_by_comm_search; // true when the comm_search 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;
double elev;
// Type of ATC control that the user's radios are tuned to.
- atc_type comm1_type;
- atc_type comm2_type;
+ atc_type comm_type[2];
// Pointer to the ATC station that the user is currently tuned into.
- FGATC* tuned_atc_ptr;
+ 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;
- bool comm1_atis_valid;
- bool comm1_tower_valid;
- bool comm1_approach_valid;
- const char* comm1_ident;
- const char* comm1_atis_ident;
- const char* comm1_tower_ident;
- const char* comm1_approach_ident;
- const char* last_comm1_ident;
- const char* last_comm1_atis_ident;
- const char* last_comm1_tower_ident;
- const char* last_comm1_approach_ident;
- const char* approach_ident;
+ // 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;
- 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;
+ //FGATIS atis;
//FGGround ground;
FGTower tower;
- FGApproach approaches[max_app];
FGApproach approach;
//FGDeparture departure;
-
- // Rendering related stuff
+
+ // Voice related stuff
bool voice; // Flag - true if we are using voice
- bool playing; // Indicates a message in progress
#ifdef ENABLE_AUDIO_SUPPORT
- string refname; // FIXME - A hack - assumes only one sound to track.
bool voiceOK; // Flag - true if at least one voice has loaded OK
- FGATCVoice v1;
+ FGATCVoice* v1;
#endif
public:
void update(double dt);
// Returns true if the airport is found in the map
- bool GetAirportATCDetails(string icao, AirportATC* a);
+ bool GetAirportATCDetails(const string& icao, AirportATC* a);
// Return a pointer to a given sort of ATC at a given airport and activate if necessary
- FGATC* GetATCPointer(string icao, atc_type type);
+ // 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]); }
- // Render a transmission
- // Outputs the transmission either on screen or as audio depending on user preference
- // The repeating flag indicates whether the message should be repeated continuously or played once.
- void Render(string msg, bool repeating);
-
- // Cease rendering a transmission.
- // At the moment this can handle one transmission active at a time only.
- void NoRender();
+ // 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);
- // Display a dialog box with options relevant to the currently tuned ATC service.
- void doStandardDialog();
+ // Register the fact that the AI system wants to activate an airport
+ bool AIRegisterAirport(const string& ident);
- atc_type GetCurrentATCType() { return(comm1_type); }
- FGATC* GetCurrentATCPointer() { return(tuned_atc_ptr); }
+ // 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);
- // Return a pointer to a class in the list (external interface to this is through GetATCPointer)
- FGATC* FindInList(const char* id, atc_type tp);
+ // 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 a specified freq for matching stations
- void Search();
+ // 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();
};