src/ATC/ATC.hxx

   1 // FGATC - abstract base class for the various actual atc classes
   2 // such as FGATIS, FGTower etc.
   3 //
   4 // Written by David Luff, started Feburary 2002.
   5 //
   6 // Copyright (C) 2002  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 #ifndef _FG_ATC_HXX
  23 #define _FG_ATC_HXX
  24
  25 #include <simgear/compiler.h>
  26 #include <simgear/misc/sgstream.hxx>
  27 #include <simgear/math/sg_geodesy.hxx>
  28 #include <simgear/debug/logstream.hxx>
  29
  30 #include STL_IOSTREAM
  31 #include STL_STRING
  32
  33 #include "ATCVoice.hxx"
  34
  35 SG_USING_STD(ostream);
  36 SG_USING_STD(string);
  37 SG_USING_STD(ios);
  38
  39 enum plane_type {
  40         UNKNOWN,
  41         GA_SINGLE,
  42         GA_HP_SINGLE,
  43         GA_TWIN,
  44         GA_JET,
  45         MEDIUM,
  46         HEAVY,
  47         MIL_JET
  48 };
  49
  50 // PlaneRec - a structure holding ATC-centric details of planes under control
  51 // This might move or change eventually
  52 struct PlaneRec {
  53         plane_type type;
  54         string callsign;
  55         int squawkcode;
  56 };
  57
  58 // Possible types of ATC type that the radios may be tuned to.
  59 // INVALID implies not tuned in to anything.
  60 enum atc_type {
  61         INVALID,
  62         ATIS,
  63         GROUND,
  64         TOWER,
  65         APPROACH,
  66         DEPARTURE,
  67         ENROUTE
  68 };
  69
  70 const int ATC_NUM_TYPES = 7;
  71
  72 // DCL - new experimental ATC data store
  73 struct ATCData {
  74         atc_type type;
  75         // I've deliberately used float instead of double here to keep the size down - we'll be storing thousands of these in memory.
  76         // In fact, we could probably ditch x, y and z and generate on the fly as needed.
  77         // On the other hand, we'll probably end up reading this data directly from the DAFIF eventually anyway!!
  78         float lon, lat, elev;
  79         float x, y, z;
  80         //int freq;
  81         unsigned short int freq;
  82         //int range;
  83         unsigned short int range;
  84         string ident;
  85         string name;
  86 };
  87
  88 // perhaps we could use an FGRunway instead of this.
  89 // That wouldn't cache the orthopos though.
  90 struct RunwayDetails {
  91         Point3D threshold_pos;
  92         Point3D end1ortho;      // ortho projection end1 (the threshold ATM)
  93         Point3D end2ortho;      // ortho projection end2 (the take off end in the current hardwired scheme)
  94         double hdg;             // true runway heading
  95         double length;  // In *METERS*
  96         double width;   // ditto
  97         string rwyID;
  98         int patternDirection;   // -1 for left, 1 for right
  99 };
 100
 101 ostream& operator << (ostream& os, atc_type atc);
 102
 103 class FGATC {
 104
 105 public:
 106
 107         FGATC();
 108         virtual ~FGATC();
 109
 110         // Run the internal calculations
 111         // Derived classes should call this method from their own Update methods if they
 112         // wish to use the response timer functionality.
 113         virtual void Update(double dt);
 114
 115         // Recieve a coded callback from the ATC menu system based on the user's selection
 116         virtual void ReceiveUserCallback(int code);
 117
 118         // Add plane to a stack
 119         virtual void AddPlane(string pid);
 120
 121         // Remove plane from stack
 122         virtual int RemovePlane();
 123
 124         // Indicate that this instance should output to the display if appropriate
 125         virtual void SetDisplay();
 126
 127         // Indicate that this instance should not output to the display
 128         virtual void SetNoDisplay();
 129
 130         // Generate the text of a message from its parameters and the current context.
 131         virtual string GenText(const string& m, int c);
 132
 133         // Returns true if OK to transmit on this frequency
 134         inline bool GetFreqClear() { return freqClear; }
 135         // Indicate that the frequency is in use
 136         inline void SetFreqInUse() { freqClear = false; receiving = true; }
 137         // Transmission to the ATC is finished and a response is required
 138         void SetResponseReqd(string rid);
 139         // Transmission finished - let ATC decide if a response is reqd and clear freq if necessary
 140         void NotifyTransmissionFinished(string rid);
 141         // Transmission finished and no response required
 142         inline void ReleaseFreq() { freqClear = true; receiving = false; }      // TODO - check that the plane releasing the freq is the right one etc.
 143         // The above 3 funcs under development!!
 144         // The idea is that AI traffic or the user ATC dialog box calls FreqInUse() when they begin transmitting,
 145         // and that the tower control sets freqClear back to true following a reply.
 146         // AI traffic should check FreqClear() is true prior to transmitting.
 147         // The user will just have to wait for a gap in dialog as in real life.
 148
 149         // Return the type of ATC station that the class represents
 150         virtual atc_type GetType();
 151
 152         // Set the core ATC data
 153         void SetData(ATCData* d);
 154
 155         inline double get_lon() const { return lon; }
 156         inline void set_lon(const double ln) {lon = ln;}
 157         inline double get_lat() const { return lat; }
 158         inline void set_lat(const double lt) {lat = lt;}
 159         inline double get_elev() const { return elev; }
 160         inline void set_elev(const double ev) {elev = ev;}
 161         inline double get_x() const { return x; }
 162         inline void set_x(const double ecs) {x = ecs;}
 163         inline double get_y() const { return y; }
 164         inline void set_y(const double why) {y = why;}
 165         inline double get_z() const { return z; }
 166         inline void set_z(const double zed) {z = zed;}
 167         inline int get_freq() const { return freq; }
 168         inline void set_freq(const int fq) {freq = fq;}
 169         inline int get_range() const { return range; }
 170         inline void set_range(const int rg) {range = rg;}
 171         inline const char* get_ident() { return ident.c_str(); }
 172         inline void set_ident(const string id) {ident = id;}
 173         inline const char* get_name() {return name.c_str();}
 174         inline void set_name(const string nm) {name = nm;}
 175
 176 protected:
 177
 178         // Render a transmission
 179         // Outputs the transmission either on screen or as audio depending on user preference
 180         // The refname is a string to identify this sample to the sound manager
 181         // The repeating flag indicates whether the message should be repeated continuously or played once.
 182         void Render(string msg, string refname, bool repeating);
 183
 184         // Cease rendering a transmission.
 185         // Requires the sound manager refname if audio, else "".
 186         void NoRender(string refname);
 187
 188         double lon, lat, elev;
 189         double x, y, z;
 190         int freq;
 191         int range;
 192         string ident;           // Code of the airport its at.
 193         string name;            // Name transmitted in the broadcast.
 194
 195         // Rendering related stuff
 196         bool voice;                     // Flag - true if we are using voice
 197         bool playing;           // Indicates a message in progress
 198         bool voiceOK;           // Flag - true if at least one voice has loaded OK
 199         FGATCVoice* vPtr;
 200
 201         bool freqClear;         // Flag to indicate if the frequency is clear of ongoing dialog
 202         bool receiving;         // Flag to indicate we are receiving a transmission
 203         bool responseReqd;      // Flag to indicate we should be responding to a request/report
 204         bool runResponseCounter;        // Flag to indicate the response counter should be run
 205         double responseTime;    // Time to take from end of request transmission to beginning of response
 206                                                         // The idea is that this will be slightly random.
 207         double responseCounter;         // counter to implement the above
 208         string responseID;      // ID of the plane to respond to
 209         bool respond;   // Flag to indicate now is the time to respond - ie set following the count down of the response timer.
 210         // Derived classes only need monitor this flag, and use the response ID, as long as they call FGATC::Update(...)
 211 };
 212
 213 inline istream&
 214 operator >> ( istream& fin, ATCData& a )
 215 {
 216         double f;
 217         char ch;
 218         char tp;
 219
 220         fin >> tp;
 221
 222         switch(tp) {
 223         case 'I':
 224                 a.type = ATIS;
 225                 break;
 226         case 'T':
 227                 a.type = TOWER;
 228                 break;
 229         case 'G':
 230                 a.type = GROUND;
 231                 break;
 232         case 'A':
 233                 a.type = APPROACH;
 234                 break;
 235         case '[':
 236                 a.type = INVALID;
 237                 return fin >> skipeol;
 238         default:
 239                 SG_LOG(SG_GENERAL, SG_ALERT, "Warning - unknown type \'" << tp << "\' found whilst reading ATC frequency data!\n");
 240                 a.type = INVALID;
 241                 return fin >> skipeol;
 242         }
 243
 244         fin >> a.lat >> a.lon >> a.elev >> f >> a.range
 245         >> a.ident;
 246
 247         a.name = "";
 248         fin >> ch;
 249         if(ch != '"') a.name += ch;
 250         while(1) {
 251                 //in >> noskipws
 252                 fin.unsetf(ios::skipws);
 253                 fin >> ch;
 254                 if((ch == '"') || (ch == 0x0A)) {
 255                         break;
 256                 }   // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
 257                 a.name += ch;
 258         }
 259         fin.setf(ios::skipws);
 260         //cout << "Comm name = " << a.name << '\n';
 261
 262         a.freq = (int)(f*100.0 + 0.5);
 263
 264         // cout << a.ident << endl;
 265
 266         // generate cartesian coordinates
 267         Point3D geod( a.lon * SGD_DEGREES_TO_RADIANS, a.lat * SGD_DEGREES_TO_RADIANS, a.elev );
 268         Point3D cart = sgGeodToCart( geod );
 269         a.x = cart.x();
 270         a.y = cart.y();
 271         a.z = cart.z();
 272
 273         return fin >> skipeol;
 274 }
 275
 276
 277 #endif  // _FG_ATC_HXX