1 // ATCDialog.cxx - Functions and classes to handle the pop-up ATC dialog
3 // Written by Alexander Kappes and David Luff, started February 2003.
5 // Copyright (C) 2003 Alexander Kappes and David Luff
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 #include <simgear/compiler.h>
27 #include <simgear/structure/commands.hxx>
29 #include <Main/globals.hxx>
30 #include <GUI/gui.h> // mkDialog
31 #include <GUI/new_gui.hxx>
33 #include "ATCDialog.hxx"
36 #include "commlist.hxx"
37 #include "ATCutils.hxx"
38 #include <Airports/simple.hxx>
42 SG_USING_STD(ostringstream);
44 FGATCDialog *current_atcdialog;
46 // For the command manager - maybe eventually this should go in the built in command list
47 static bool do_ATC_dialog(const SGPropertyNode* arg) {
48 current_atcdialog->PopupDialog();
52 static bool do_ATC_freq_search(const SGPropertyNode* arg) {
53 current_atcdialog->FreqDialog();
57 ATCMenuEntry::ATCMenuEntry() {
65 ATCMenuEntry::~ATCMenuEntry() {
68 static void atcUppercase(string &s) {
69 for(unsigned int i=0; i<s.size(); ++i) {
74 // find child whose <name>...</name> entry matches 'name'
75 static SGPropertyNode *getNamedNode(SGPropertyNode *prop, const char *name) {
78 for (int i = 0; i < prop->nChildren(); i++)
79 if ((p = getNamedNode(prop->getChild(i), name)))
82 if (!strcmp(prop->getStringValue("name"), name))
89 FGATCDialog::FGATCDialog() {
90 _callbackPending = false;
95 _gui = (NewGUI *)globals->get_subsystem("gui");
98 FGATCDialog::~FGATCDialog() {
101 void FGATCDialog::Init() {
102 // Add ATC-dialog to the command list
103 globals->get_commands()->addCommand("ATC-dialog", do_ATC_dialog);
104 // Add ATC-freq-search to the command list
105 globals->get_commands()->addCommand("ATC-freq-search", do_ATC_freq_search);
107 // initialize properties polled in Update()
108 globals->get_props()->setStringValue("/sim/atc/freq-airport", "");
109 globals->get_props()->setIntValue("/sim/atc/transmission-num", -1);
112 void FGATCDialog::Update(double dt) {
113 static SGPropertyNode_ptr airport = globals->get_props()->getNode("/sim/atc/freq-airport", true);
114 string s = airport->getStringValue();
116 airport->setStringValue("");
120 static SGPropertyNode_ptr trans_num = globals->get_props()->getNode("/sim/atc/transmission-num", true);
121 int n = trans_num->getIntValue();
123 trans_num->setIntValue(-1);
127 if(_callbackPending) {
128 if(_callbackTimer > _callbackWait) {
129 _callbackPtr->ReceiveUserCallback(_callbackCode);
130 _callbackPtr->NotifyTransmissionFinished(fgGetString("/sim/user/callsign"));
131 _callbackPending = false;
133 _callbackTimer += dt;
139 void FGATCDialog::add_entry(const string& station, const string& transmission, const string& menutext, atc_type type, int code) {
143 a.stationid = station;
144 a.transmission = transmission;
145 a.menuentry = menutext;
146 a.callback_code = code;
148 (available_dialog[type])[station.c_str()].push_back(a);
152 void FGATCDialog::remove_entry( const string &station, const string &trans, atc_type type ) {
153 atcmentry_vec_type* p = &((available_dialog[type])[station]);
154 atcmentry_vec_iterator current = p->begin();
155 while(current != p->end()) {
156 if(current->transmission == trans) current = p->erase(current);
161 void FGATCDialog::remove_entry( const string &station, int code, atc_type type ) {
162 atcmentry_vec_type* p = &((available_dialog[type])[station]);
163 atcmentry_vec_iterator current = p->begin();
164 while(current != p->end()) {
165 if(current->callback_code == code) current = p->erase(current);
170 // query the database whether the transmission is already registered;
171 bool FGATCDialog::trans_reg( const string &station, const string &trans, atc_type type ) {
172 atcmentry_vec_type* p = &((available_dialog[type])[station]);
173 atcmentry_vec_iterator current = p->begin();
174 for ( ; current != p->end() ; ++current ) {
175 if ( current->transmission == trans ) return true;
180 // query the database whether the transmission is already registered;
181 bool FGATCDialog::trans_reg( const string &station, int code, atc_type type ) {
182 atcmentry_vec_type* p = &((available_dialog[type])[station]);
183 atcmentry_vec_iterator current = p->begin();
184 for ( ; current != p->end() ; ++current ) {
185 if ( current->callback_code == code ) return true;
190 // Display the ATC popup dialog box with options relevant to the users current situation.
191 void FGATCDialog::PopupDialog() {
192 const char *dialog_name = "atc-dialog";
193 SGPropertyNode_ptr dlg = _gui->getDialogProperties(dialog_name);
197 _gui->closeDialog(dialog_name);
199 SGPropertyNode_ptr button_group = getNamedNode(dlg, "transmission-choice");
200 // remove all transmission buttons
201 button_group->removeChildren("button", false);
204 FGATC* atcptr = globals->get_ATC_mgr()->GetComm1ATCPointer(); // Hardwired to comm1 at the moment
207 label = "Not currently tuned to any ATC service";
208 mkDialog(label.c_str());
212 if(atcptr->GetType() == ATIS) {
213 label = "Tuned to ATIS - no communication possible";
214 mkDialog(label.c_str());
218 atcmentry_vec_type atcmlist = (available_dialog[atcptr->GetType()])[atcptr->get_ident()];
219 atcmentry_vec_iterator current = atcmlist.begin();
220 atcmentry_vec_iterator last = atcmlist.end();
222 if(!atcmlist.size()) {
223 label = "No transmission available";
224 mkDialog(label.c_str());
228 const int bufsize = 32;
230 // loop over all entries in atcmentrylist
231 for (int n = 0; n < 10; ++n) {
232 snprintf(buf, bufsize, "/sim/atc/opt[%d]", n);
233 fgSetBool(buf, false);
238 // add transmission button (modified copy of <button-template>)
239 SGPropertyNode *entry = button_group->getNode("button", n, true);
240 copyProperties(button_group->getNode("button-template", true), entry);
241 entry->removeChildren("hide", false);
242 entry->setStringValue("property", buf);
243 entry->setIntValue("keynum", '1' + n);
245 entry->setBoolValue("default", true);
247 snprintf(buf, bufsize, "%d", n + 1);
248 string legend = string(buf) + ". " + current->menuentry;
249 entry->setStringValue("legend", legend.c_str());
250 entry->setIntValue("binding/value", n);
254 _gui->showDialog(dialog_name);
258 void FGATCDialog::PopupCallback(int num) {
259 FGATC* atcptr = globals->get_ATC_mgr()->GetComm1ATCPointer(); // FIXME - Hardwired to comm1 at the moment
264 if (atcptr->GetType() == TOWER) {
265 //cout << "TOWER " << endl;
266 //cout << "ident is " << atcptr->get_ident() << endl;
267 atcmentry_vec_type atcmlist = (available_dialog[TOWER])[atcptr->get_ident()];
268 unsigned int size = atcmlist.size();
269 if(size && num < size) {
270 //cout << "Doing callback...\n";
271 ATCMenuEntry a = atcmlist[num];
272 atcptr->SetFreqInUse();
273 string pilot = atcptr->GenText(a.transmission, a.callback_code);
274 fgSetString("/sim/messages/pilot", pilot.c_str());
275 // This is the user's speech getting displayed.
276 _callbackPending = true;
277 _callbackTimer = 0.0;
279 _callbackPtr = atcptr;
280 _callbackCode = a.callback_code;
282 //cout << "No options available...\n";
284 //cout << "Donded" << endl;
288 // map() key data type (removes duplicates and sorts by distance)
291 atcdata(const string i, const string n, const double d) {
292 id = i, name = n, distance = d;
294 bool operator<(const atcdata& a) const {
295 return id != a.id && distance < a.distance;
297 bool operator==(const atcdata& a) const {
298 return id == a.id && distance == a.distance;
305 void FGATCDialog::FreqDialog() {
306 const char *dialog_name = "atc-freq-search";
307 SGPropertyNode_ptr dlg = _gui->getDialogProperties(dialog_name);
311 _gui->closeDialog(dialog_name);
313 SGPropertyNode_ptr button_group = getNamedNode(dlg, "quick-buttons");
314 // remove all dynamic airport/ATC buttons
315 button_group->removeChildren("button", false);
317 // Find the ATC stations within a reasonable range
318 comm_list_type atc_stations;
319 comm_list_iterator atc_stat_itr;
321 double lon = fgGetDouble("/position/longitude-deg");
322 double lat = fgGetDouble("/position/latitude-deg");
323 double elev = fgGetDouble("/position/altitude-ft");
324 Point3D aircraft = sgGeodToCart(Point3D(lon * SGD_DEGREES_TO_RADIANS,
325 lat * SGD_DEGREES_TO_RADIANS, elev));
327 // search stations in range
328 int num_stat = current_commlist->FindByPos(lon, lat, elev, 50.0, &atc_stations);
330 map<atcdata, bool> uniq;
331 // fill map (sorts by distance and removes duplicates)
332 comm_list_iterator itr = atc_stations.begin();
333 for (; itr != atc_stations.end(); ++itr) {
334 Point3D station = Point3D(itr->x, itr->y, itr->z);
335 double distance = aircraft.distance3Dsquared(station);
336 uniq[atcdata(itr->ident, itr->name, distance)] = true;
338 // create button per map entry (modified copy of <button-template>)
339 map<atcdata, bool>::iterator uit = uniq.begin();
340 for (int n = 0; uit != uniq.end() && n < 6; ++uit, ++n) { // max 6 buttons
341 SGPropertyNode *entry = button_group->getNode("button", n, true);
342 copyProperties(button_group->getNode("button-template", true), entry);
343 entry->removeChildren("hide", false);
344 entry->setStringValue("legend", uit->first.id.c_str());
345 entry->setStringValue("binding[0]/value", uit->first.id.c_str());
349 // (un)hide message saying no things in range
350 SGPropertyNode_ptr range_error = getNamedNode(dlg, "no-atc-in-range");
351 range_error->setBoolValue("hide", num_stat);
353 _gui->showDialog(dialog_name);
356 void FGATCDialog::FreqDisplay(string& ident) {
357 const char *dialog_name = "atc-freq-display";
358 SGPropertyNode_ptr dlg = _gui->getDialogProperties(dialog_name);
362 _gui->closeDialog(dialog_name);
364 SGPropertyNode_ptr freq_group = getNamedNode(dlg, "frequency-list");
365 // remove all frequency entries
366 freq_group->removeChildren("group", false);
371 const FGAirport *a = fgFindAirportID(ident);
373 label = "Airport " + ident + " not found in database.";
374 mkDialog(label.c_str());
379 label = ident + " Frequencies";
380 dlg->setStringValue("text/label", label.c_str());
382 int n = 0; // Number of ATC frequencies at this airport
384 comm_list_type stations;
385 int found = current_commlist->FindByPos(a->getLongitude(), a->getLatitude(), a->getElevation(), 20.0, &stations);
388 comm_list_iterator itr = stations.begin();
389 for (n = 0; itr != stations.end(); ++itr) {
390 if(itr->ident != ident)
393 if(itr->type == INVALID)
396 // add frequency line (modified copy of <group-template>)
397 SGPropertyNode *entry = freq_group->getNode("group", n, true);
398 copyProperties(freq_group->getNode("group-template", true), entry);
399 entry->removeChildren("hide", false);
402 entry->setStringValue("text[0]/label", ostr.str().c_str());
405 snprintf(buf, 8, "%.2f", (itr->freq / 100.0)); // Convert from KHz to MHz
406 if(buf[5] == '3') buf[5] = '2';
407 if(buf[5] == '8') buf[5] = '7';
410 entry->setStringValue("text[1]/label", buf);
417 label = "No frequencies found for airport " + ident;
418 mkDialog(label.c_str());
422 _gui->showDialog(dialog_name);