src/ATC/ATCutils.cxx

   1 // ATCutils.cxx - Utility functions for the ATC / AI system
   2 //
   3 // Written by David Luff, started March 2002.
   4 //
   5 // Copyright (C) 2002  David C Luff - david.luff@nottingham.ac.uk
   6 //
   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.
  11 //
  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.
  16 //
  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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 #include <math.h>
  22 #include <simgear/math/point3d.hxx>
  23 #include <simgear/constants.h>
  24 #include <simgear/misc/sg_path.hxx>
  25 #include <simgear/debug/logstream.hxx>
  26 #include <plib/sg.h>
  27 //#include <iomanip.h>
  28
  29 #include <Airports/runways.hxx>
  30 #include <Main/globals.hxx>
  31
  32 #include "ATCutils.hxx"
  33
  34 // Convert any number to spoken digits
  35 string ConvertNumToSpokenDigits(string n) {
  36         //cout << "n = " << n << endl;
  37         string nums[10] = {"zero", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine"};
  38         string pt = "decimal";
  39         string str = "";
  40
  41         for(unsigned int i=0; i<n.length(); ++i) {
  42                 //cout << "n.substr(" << i << ",1 = " << n.substr(i,1) << endl;
  43                 if(n.substr(i,1) == " ") {
  44                         // do nothing
  45                 } else if(n.substr(i,1) == ".") {
  46                         str += pt;
  47                 } else {
  48                         str += nums[atoi((n.substr(i,1)).c_str())];
  49                 }
  50                 if(i != (n.length()-1)) {       // ie. don't add a space at the end.
  51                         str += " ";
  52                 }
  53         }
  54
  55         return(str);
  56 }
  57
  58 // Convert a 2 digit rwy number to a spoken-style string
  59 string ConvertRwyNumToSpokenString(int n) {
  60         string nums[10] = {"zero", "one", "two", "three", "four", "five", "six", "seven", "eight", "nine"};
  61         // Basic error/sanity checking
  62         while(n < 0) {
  63                 n += 36;
  64         }
  65         while(n > 36) {
  66                 n -= 36;
  67         }
  68         if(n == 0) {
  69                 n = 36; // Is this right?
  70         }
  71
  72         string str = "";
  73         int index = n/10;
  74         str += nums[index];
  75         n -= (index * 10);
  76         //str += "-";
  77         str += " ";             //Changed this for the benefit of the voice token parser - prefer the "-" in the visual output though.
  78         str += nums[n];
  79         return(str);
  80 }
  81
  82 // Assumes we get a two-digit string optionally appended with R or L
  83 // eg 01 07L 29R 36
  84 // Anything else is not guaranteed to be handled correctly!
  85 string ConvertRwyNumToSpokenString(string s) {
  86         if(s.size() < 3) {
  87                 return(ConvertRwyNumToSpokenString(atoi(s.c_str())));
  88         } else {
  89                 string r = ConvertRwyNumToSpokenString(atoi(s.substr(0,2).c_str()));
  90                 return(r += (s.substr(2,1) == "L" ? " left" : " right"));       // Warning - not much error checking there!
  91         }
  92 }
  93
  94
  95 // Return the phonetic letter of a letter represented as an integer 1->26
  96 string GetPhoneticIdent(int i) {
  97         // TODO - Check i is between 1 and 26 and wrap if necessary
  98         switch(i) {
  99         case 1 : return("alpha");
 100         case 2 : return("bravo");
 101         case 3 : return("charlie");
 102         case 4 : return("delta");
 103         case 5 : return("echo");
 104         case 6 : return("foxtrot");
 105         case 7 : return("golf");
 106         case 8 : return("hotel");
 107         case 9 : return("india");
 108         case 10 : return("juliet");
 109         case 11 : return("kilo");
 110         case 12 : return("lima");
 111         case 13 : return("mike");
 112         case 14 : return("november");
 113         case 15 : return("oscar");
 114         case 16 : return("papa");
 115         case 17 : return("quebec");
 116         case 18 : return("romeo");
 117         case 19 : return("sierra");
 118         case 20 : return("tango");
 119         case 21 : return("uniform");
 120         case 22 : return("victor");
 121         case 23 : return("whiskey");
 122         case 24 : return("x-ray");
 123         case 25 : return("yankee");
 124         case 26 : return("zulu");
 125         }
 126         // We shouldn't get here
 127         return("Error");
 128 }
 129
 130 // Given two positions (lat & lon in degrees), get the HORIZONTAL separation (in meters)
 131 double dclGetHorizontalSeparation(Point3D pos1, Point3D pos2) {
 132         double x;       //East-West separation
 133         double y;       //North-South separation
 134         double z;       //Horizontal separation - z = sqrt(x^2 + y^2)
 135
 136         double lat1 = pos1.lat() * SG_DEGREES_TO_RADIANS;
 137         double lon1 = pos1.lon() * SG_DEGREES_TO_RADIANS;
 138         double lat2 = pos2.lat() * SG_DEGREES_TO_RADIANS;
 139         double lon2 = pos2.lon() * SG_DEGREES_TO_RADIANS;
 140
 141         y = sin(fabs(lat1 - lat2)) * SG_EQUATORIAL_RADIUS_M;
 142         x = sin(fabs(lon1 - lon2)) * SG_EQUATORIAL_RADIUS_M * (cos((lat1 + lat2) / 2.0));
 143         z = sqrt(x*x + y*y);
 144
 145         return(z);
 146 }
 147
 148 // Given a point and a line, get the HORIZONTAL shortest distance from the point to a point on the line.
 149 // Expects to be fed orthogonal co-ordinates, NOT lat & lon !
 150 // The units of the separation will be those of the input.
 151 double dclGetLinePointSeparation(double px, double py, double x1, double y1, double x2, double y2) {
 152         double vecx = x2-x1;
 153         double vecy = y2-y1;
 154         double magline = sqrt(vecx*vecx + vecy*vecy);
 155         double u = ((px-x1)*(x2-x1) + (py-y1)*(y2-y1)) / (magline * magline);
 156         double x0 = x1 + u*(x2-x1);
 157         double y0 = y1 + u*(y2-y1);
 158         vecx = px - x0;
 159         vecy = py - y0;
 160         double d = sqrt(vecx*vecx + vecy*vecy);
 161         if(d < 0) {
 162                 d *= -1;
 163         }
 164         return(d);
 165 }
 166
 167 // Given a position (lat/lon/elev), heading and vertical angle (degrees), and distance (meters), calculate the new position.
 168 // This function assumes the world is spherical.  If geodetic accuracy is required use the functions is sg_geodesy instead!
 169 // Assumes that the ground is not hit!!!  Expects heading and angle in degrees, distance in meters.
 170 Point3D dclUpdatePosition(Point3D pos, double heading, double angle, double distance) {
 171         //cout << setprecision(10) << pos.lon() << ' ' << pos.lat() << '\n';
 172         heading *= DCL_DEGREES_TO_RADIANS;
 173         angle *= DCL_DEGREES_TO_RADIANS;
 174         double lat = pos.lat() * DCL_DEGREES_TO_RADIANS;
 175         double lon = pos.lon() * DCL_DEGREES_TO_RADIANS;
 176         double elev = pos.elev();
 177         //cout << setprecision(10) << lon*DCL_RADIANS_TO_DEGREES << ' ' << lat*DCL_RADIANS_TO_DEGREES << '\n';
 178
 179         double horiz_dist = distance * cos(angle);
 180         double vert_dist = distance * sin(angle);
 181
 182         double north_dist = horiz_dist * cos(heading);
 183         double east_dist = horiz_dist * sin(heading);
 184
 185         //cout << distance << ' ' << horiz_dist << ' ' << vert_dist << ' ' << north_dist << ' ' << east_dist << '\n';
 186
 187         double delta_lat = asin(north_dist / (double)SG_EQUATORIAL_RADIUS_M);
 188         double delta_lon = asin(east_dist / (double)SG_EQUATORIAL_RADIUS_M) * (1.0 / cos(lat));  // I suppose really we should use the average of the original and new lat but we'll assume that this will be good enough.
 189         //cout << delta_lon*DCL_RADIANS_TO_DEGREES << ' ' << delta_lat*DCL_RADIANS_TO_DEGREES << '\n';
 190         lat += delta_lat;
 191         lon += delta_lon;
 192         elev += vert_dist;
 193         //cout << setprecision(10) << lon*DCL_RADIANS_TO_DEGREES << ' ' << lat*DCL_RADIANS_TO_DEGREES << '\n';
 194
 195         //cout << setprecision(15) << DCL_DEGREES_TO_RADIANS * DCL_RADIANS_TO_DEGREES << '\n';
 196
 197         return(Point3D(lon*DCL_RADIANS_TO_DEGREES, lat*DCL_RADIANS_TO_DEGREES, elev));
 198 }
 199
 200 // Get a heading in degrees from one lat/lon to another.
 201 // This function assumes the world is spherical.  If geodetic accuracy is required use the functions is sg_geodesy instead!
 202 // Warning - at the moment we are not checking for identical points - currently it returns 90 in this instance.
 203 double GetHeadingFromTo(Point3D A, Point3D B) {
 204         double latA = A.lat() * DCL_DEGREES_TO_RADIANS;
 205         double lonA = A.lon() * DCL_DEGREES_TO_RADIANS;
 206         double latB = B.lat() * DCL_DEGREES_TO_RADIANS;
 207         double lonB = B.lon() * DCL_DEGREES_TO_RADIANS;
 208         double xdist = sin(lonB - lonA) * (double)SG_EQUATORIAL_RADIUS_M * cos((latA+latB)/2.0);
 209         double ydist = sin(latB - latA) * (double)SG_EQUATORIAL_RADIUS_M;
 210
 211         if(xdist >= 0) {
 212                 if(ydist > 0) {
 213                         return(atan(xdist/ydist) * DCL_RADIANS_TO_DEGREES);
 214                 } else if (ydist == 0) {
 215                         return(90.0);
 216                 } else {
 217                         return(180.0 - atan(xdist/fabs(ydist)) * DCL_RADIANS_TO_DEGREES);
 218                 }
 219         } else {
 220                 if(ydist > 0) {
 221                         return(360.0 - atan(fabs(xdist)/ydist) * DCL_RADIANS_TO_DEGREES);
 222                 } else if (ydist == 0) {
 223                         return(270.0);
 224                 } else {
 225                         return(180.0 + atan(xdist/ydist) * DCL_RADIANS_TO_DEGREES);
 226                 }
 227         }
 228 }
 229
 230 // Given a heading (in degrees), bound it from 0 -> 360
 231 void dclBoundHeading(double &hdg) {
 232         while(hdg < 0.0) {
 233                 hdg += 360.0;
 234         }
 235         while(hdg > 360.0) {
 236                 hdg -= 360.0;
 237         }
 238 }
 239
 240 // Airport stuff.  The next two functions are straight copies of their fg.... equivalents
 241 // in fg_init.cxx, and are just here temporarily until some rationalisation occurs.
 242 // find basic airport location info from airport database
 243 bool dclFindAirportID( const string& id, FGAirport *a ) {
 244     if ( id.length() ) {
 245         SGPath path( globals->get_fg_root() );
 246         path.append( "Airports" );
 247         path.append( "simple.mk4" );
 248         FGAirports airports( path.c_str() );
 249
 250         SG_LOG( SG_GENERAL, SG_INFO, "Searching for airport code = " << id );
 251
 252         if ( ! airports.search( id, a ) ) {
 253             SG_LOG( SG_GENERAL, SG_ALERT,
 254                     "Failed to find " << id << " in " << path.str() );
 255             return false;
 256         }
 257     } else {
 258         return false;
 259     }
 260
 261     SG_LOG( SG_GENERAL, SG_INFO,
 262             "Position for " << id << " is ("
 263             << a->longitude << ", "
 264             << a->latitude << ")" );
 265
 266     return true;
 267 }
 268
 269 // get airport elevation
 270 double dclGetAirportElev( const string& id ) {
 271     FGAirport a;
 272     // double lon, lat;
 273
 274     SG_LOG( SG_GENERAL, SG_INFO,
 275             "Finding elevation for airport: " << id );
 276
 277     if ( dclFindAirportID( id, &a ) ) {
 278         return a.elevation;
 279     } else {
 280         return -9999.0;
 281     }
 282 }