src/ATC/atis.cxx

   1 // atis.cxx - routines to generate the ATIS info string
   2 // This is the implementation of the FGATIS class
   3 //
   4 // Written by David Luff, started October 2001.
   5 //
   6 // Copyright (C) 2001  David C Luff - david.luff@nottingham.ac.uk
   7 //
   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.
  12 //
  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.
  17 //
  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., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include <config.h>
  25 #endif
  26
  27 #include <simgear/compiler.h>
  28
  29 #include <stdlib.h>     // atoi()
  30 #include <stdio.h>      // sprintf
  31 #include <string>
  32 SG_USING_STD(string);
  33
  34 #include STL_IOSTREAM
  35 SG_USING_STD(cout);
  36
  37 //#include <simgear/debug/logstream.hxx>
  38 //#include <simgear/misc/sgstream.hxx>
  39 #include <simgear/misc/sg_path.hxx>
  40
  41 #ifdef FG_WEATHERCM
  42 # include <WeatherCM/FGLocalWeatherDatabase.h>
  43 #else
  44 # include <Environment/environment_mgr.hxx>
  45 # include <Environment/environment.hxx>
  46 #endif
  47
  48 #include <Main/fg_props.hxx>
  49 #include <Main/globals.hxx>
  50 #include <Airports/runways.hxx>
  51
  52 #include "atis.hxx"
  53 #include "atislist.hxx"
  54 #include "ATCdisplay.hxx"
  55 #include "ATCutils.hxx"
  56 #include "ATCmgr.hxx"
  57
  58 // Constructor
  59 FGATIS::FGATIS()
  60 : type(0),
  61 lon(0.0), lat(0.0),
  62 elev(0.0),
  63 x(0.0), y(0.0), z(0.0),
  64 freq(0),
  65 range(0),
  66 display(false),
  67 displaying(false),
  68 ident(""),
  69 name(""),
  70 transmission(""),
  71 trans_ident(""),
  72 atis_failed(false),
  73 refname("atis")
  74 {
  75 }
  76
  77 // Destructor
  78 FGATIS::~FGATIS() {
  79 }
  80
  81 // Main update function - checks whether we are displaying or not the correct message.
  82 void FGATIS::Update() {
  83         if(display) {
  84                 if(displaying) {
  85                         // Check if we need to update the message
  86                         // - basically every hour and if the weather changes significantly at the station
  87                         //globals->get_ATC_display()->ChangeRepeatingMessage(transmission);
  88                 } else {
  89                         // We need to get and display the message
  90                         UpdateTransmission();
  91                         //cout << "ATIS.CXX - calling ATCMgr to render transmission..." << endl;
  92                         globals->get_ATC_mgr()->Render(transmission, refname, true);
  93                         displaying = true;
  94                 }
  95         } else {
  96                 // We shouldn't be displaying
  97                 if(displaying) {
  98                         //cout << "ATIS.CXX - calling NoRender()..." << endl;
  99                         globals->get_ATC_mgr()->NoRender(refname);
 100                         displaying = false;
 101                 }
 102         }
 103 }
 104
 105 // Sets the actual broadcast ATIS transmission.
 106 void FGATIS::UpdateTransmission() {
 107         double visibility;
 108         char buf[10];
 109         int phonetic_id;
 110         string phonetic_id_string;
 111         string time_str = fgGetString("sim/time/gmt-string");
 112         int hours;
 113         // int minutes;
 114
 115         #ifdef FG_WEATHERCM
 116         sgVec3 position = { lat, lon, elev };
 117         FGPhysicalProperty stationweather = WeatherDatabase->get(position);
 118         #else
 119         FGEnvironment stationweather =
 120         globals->get_environment_mgr()->getEnvironment(lat, lon, elev);
 121         #endif
 122
 123         transmission = "";
 124
 125         // UK CAA radiotelephony manual indicated ATIS transmissions start with "This is"
 126         // Not sure about rest of the world though.
 127         transmission += "This_is ";
 128         // transmitted station name.
 129         transmission += name;
 130         // Add "Information"
 131         transmission += " information";
 132
 133         //cout << "In atis.cxx, time_str = " << time_str << '\n';
 134         // Add the recording identifier
 135         // For now we will assume we only transmit every hour
 136         hours = atoi((time_str.substr(1,2)).c_str());   //Warning - this is fragile if the
 137         //time string format changes
 138         //cout << "In atis.cxx, hours = " << hours << endl;
 139         phonetic_id = current_atislist->GetCallSign(ident, hours, 0);
 140         phonetic_id_string = GetPhoneticIdent(phonetic_id);
 141         transmission += " ";
 142         transmission += phonetic_id_string;
 143
 144         // Output the recording time. - we'll just output the last whole hour for now.
 145         // FIXME - this only gets GMT time but that appears to be all the clock outputs for now
 146         //cout << "in atis.cxx, time = " << time_str << endl;
 147         transmission = transmission + " / Weather " + ConvertNumToSpokenDigits((time_str.substr(0,3) + "00")) + " hours zulu";
 148
 149         // Get the temperature
 150         // (Hardwire it for now since the global property returns the temperature at the current altitude
 151         //temperature = fgGetDouble("/environment/weather/temperature-K");
 152         #ifdef FG_WEATHERCM
 153         sprintf(buf, "%i", int(stationweather.Temperature - 273.15));
 154         #else
 155         // HACK ALERT - at the moment the new environment subsystem returns bogus temperatures
 156         // FIXME - take out this hack when this gets fixed upstream
 157         int temp = (int)stationweather.get_temperature_degc();
 158         if((temp < -50) || (temp > 60)) {
 159                 temp = 15;
 160         }
 161         // original:
 162         //sprintf(buf, "%d", int(stationweather.get_temperature_degc()));
 163         // hack:
 164         sprintf(buf, "%d", temp);
 165         #endif
 166         transmission += " / Temperature ";
 167         if(temp < 0) {
 168                 transmission += "minus ";
 169         }
 170         string tempstr1 = buf;
 171         string tempstr2;
 172         transmission += ConvertNumToSpokenDigits(tempstr1);
 173         transmission += " degrees_Celsius";
 174
 175         // Get the visibility
 176         #ifdef FG_WEATHERCM
 177         visibility = fgGetDouble("/environment/visibility-m");
 178         #else
 179         visibility = stationweather.get_visibility_m();
 180         #endif
 181         sprintf(buf, "%i", int(visibility/1600));
 182         transmission += " / Visibility ";
 183         tempstr1 = buf;
 184         transmission += ConvertNumToSpokenDigits(tempstr1);
 185         transmission += " miles";
 186
 187         // Get the cloudbase
 188         // FIXME: kludge for now
 189         if (strcmp(fgGetString("/environment/clouds/layer[0]/type"), "clear")) {
 190                 double cloudbase =
 191                 fgGetDouble("/environment/clouds/layer[0]/elevation-ft");
 192                 // For some reason the altitude returned doesn't seem to correspond to the actual cloud altitude.
 193                 char buf3[10];
 194                 char buf4[10];
 195                 // cout << "cloudbase = " << cloudbase << endl;
 196                 sprintf(buf3, "%i", int(cloudbase)/1000);
 197                 sprintf(buf4, "%i", ((int)cloudbase % 1000)/100);
 198                 transmission += " / Cloudbase";
 199                 if(int(cloudbase)/1000) {
 200                         tempstr1 = buf3;
 201                         transmission = transmission + " " + ConvertNumToSpokenDigits(tempstr1) + " thousand";
 202                 }
 203                 if(((int)cloudbase % 1000)/100) {
 204                         tempstr1 = buf4;
 205                         transmission = transmission + " " + ConvertNumToSpokenDigits(tempstr1) + " hundred";
 206                 }
 207                 transmission += " feet";
 208         }
 209
 210         // Get the pressure / altimeter
 211
 212         #ifndef FG_WEATHERCM
 213         double altimeter = stationweather.get_pressure_sea_level_inhg();
 214         sprintf(buf, "%.2f", altimeter);
 215         transmission += " / Altimeter ";
 216         tempstr1 = buf;
 217         transmission += ConvertNumToSpokenDigits(tempstr1);
 218         #endif
 219
 220         // Based on the airport-id and wind get the active runway
 221         //FGRunway *r;
 222         SGPath path( globals->get_fg_root() );
 223         path.append( "Airports" );
 224         path.append( "runways.mk4" );
 225         FGRunways runways( path.c_str() );
 226
 227         #ifdef FG_WEATHERCM
 228         //Set the heading to into the wind
 229         double wind_x = stationweather.Wind[0];
 230         double wind_y = stationweather.Wind[1];
 231
 232         double speed = sqrt( wind_x*wind_x + wind_y*wind_y ) * SG_METER_TO_NM / (60.0*60.0);
 233         double hdg;
 234
 235         //If no wind use 270degrees
 236         if(speed == 0) {
 237                 hdg = 270;
 238                 transmission += " / Winds_light_and_variable";
 239         } else {
 240                 // //normalize the wind to get the direction
 241                 //wind_x /= speed; wind_y /= speed;
 242
 243                 hdg = - atan2 ( wind_x, wind_y ) * SG_RADIANS_TO_DEGREES ;
 244                 if (hdg < 0.0)
 245                         hdg += 360.0;
 246
 247                 //add a description of the wind to the transmission
 248                 char buf5[10];
 249                 char buf6[10];
 250                 sprintf(buf5, "%i", int(speed));
 251                 sprintf(buf6, "%i", int(hdg));
 252                 tempstr1 = buf5;
 253                 tempstr2 = buf6;
 254                 transmission = transmission + " / Winds " + ConvertNumToSpokenDigits(tempstr1) + " knots from "
 255                                             + ConvertNumToSpokenDigits(tempstr2) + " degrees";
 256         }
 257         #else
 258         double speed = stationweather.get_wind_speed_kt();
 259         double hdg = stationweather.get_wind_from_heading_deg();
 260         if (speed == 0) {
 261                 transmission += " / Winds_light_and_variable";
 262         } else {
 263                 // FIXME: get gust factor in somehow
 264                 char buf5[10];
 265                 char buf6[10];
 266                 sprintf(buf5, "%i", int(speed));
 267                 sprintf(buf6, "%i", int(hdg));
 268                 tempstr1 = buf5;
 269                 tempstr2 = buf6;
 270                 transmission = transmission + " / Winds " + ConvertNumToSpokenDigits(tempstr1) + " knots from "
 271                                             + ConvertNumToSpokenDigits(tempstr2) + " degrees";
 272         }
 273         #endif
 274
 275         string rwy_no = runways.search(ident, int(hdg));
 276         if(rwy_no != (string)"NN") {
 277                 transmission += " / Landing_and_departing_runway ";
 278                 transmission += ConvertRwyNumToSpokenString(atoi(rwy_no.c_str()));
 279                 //cout << "in atis.cxx, r.rwy_no = " << rwy_no << " r.id = " << r->id << " r.heading = " << r->heading << endl;
 280         }
 281
 282         // Anything else?
 283
 284         transmission += " / Advise_controller_on_initial_contact_you_have ";
 285         transmission += phonetic_id_string;
 286         transmission += " /// ";
 287 }