src/ATCDCL/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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22 #ifndef _FG_ATC_HXX
  23 #define _FG_ATC_HXX
  24
  25 #include <simgear/constants.h>
  26 #include <simgear/compiler.h>
  27 #include <simgear/misc/sgstream.hxx>
  28 #include <simgear/math/sg_geodesy.hxx>
  29 #include <simgear/debug/logstream.hxx>
  30
  31 #include <iosfwd>
  32 #include <string>
  33
  34 #include "ATCVoice.hxx"
  35
  36 // Convert a frequency in MHz to tens of kHz
  37 // so we can use it e.g. as an index into commlist_freq
  38 //
  39 // If freq > 1000 assume it's already in tens of KHz;
  40 // otherwise assume MHz.
  41 //
  42 // Note:  122.375 must be rounded DOWN to 12237
  43 // in order to be consistent with apt.dat et cetera.
  44 inline int kHz10(double freq)
  45 {
  46  if (freq > 1000.) return int(freq);
  47  return int(freq*100.0 + 0.25);
  48 }
  49
  50 enum plane_type {
  51         UNKNOWN,
  52         GA_SINGLE,
  53         GA_HP_SINGLE,
  54         GA_TWIN,
  55         GA_JET,
  56         MEDIUM,
  57         HEAVY,
  58         MIL_JET
  59 };
  60
  61 // PlaneRec - a structure holding ATC-centric details of planes under control
  62 // This might move or change eventually
  63 struct PlaneRec {
  64         plane_type type;
  65         std::string callsign;
  66         int squawkcode;
  67 };
  68
  69 // Possible types of ATC type that the radios may be tuned to.
  70 // INVALID implies not tuned in to anything.
  71 enum atc_type {
  72         AWOS,
  73         ATIS,
  74         GROUND,
  75         TOWER,
  76         APPROACH,
  77         DEPARTURE,
  78         ENROUTE,
  79   INVALID     /* must be last element;  see ATC_NUM_TYPES */
  80 };
  81
  82 const int ATC_NUM_TYPES = 1 + INVALID;
  83
  84 // DCL - new experimental ATC data store
  85 struct ATCData {
  86         atc_type type;
  87   SGGeod geod;
  88   SGVec3d cart;
  89         unsigned short int freq;
  90         unsigned short int range;
  91         std::string ident;
  92         std::string name;
  93 };
  94
  95 // perhaps we could use an FGRunway instead of this.
  96 // That wouldn't cache the orthopos though.
  97 struct RunwayDetails {
  98         SGGeod threshold_pos;
  99         SGVec3d end1ortho;      // ortho projection end1 (the threshold ATM)
 100         SGVec3d end2ortho;      // ortho projection end2 (the take off end in the current hardwired scheme)
 101         double hdg;             // true runway heading
 102         double length;  // In *METERS*
 103         double width;   // ditto
 104         std::string rwyID;
 105         int patternDirection;   // -1 for left, 1 for right
 106 };
 107
 108 std::ostream& operator << (std::ostream& os, atc_type atc);
 109
 110 class FGATC {
 111   friend class FGATCMgr;
 112 public:
 113
 114         FGATC();
 115         virtual ~FGATC();
 116
 117   virtual void Init()=0;
 118
 119         // Run the internal calculations
 120         // Derived classes should call this method from their own Update methods if they
 121         // wish to use the response timer functionality.
 122         virtual void Update(double dt);
 123
 124         // Recieve a coded callback from the ATC menu system based on the user's selection
 125         virtual void ReceiveUserCallback(int code);
 126
 127         // Add plane to a stack
 128         virtual void AddPlane(const std::string& pid);
 129
 130         // Remove plane from stack
 131         virtual int RemovePlane();
 132
 133         // Indicate that this instance should output to the display if appropriate
 134         inline void SetDisplay() { _display = true; }
 135
 136         // Indicate that this instance should not output to the display
 137         inline void SetNoDisplay() { _display = false; }
 138
 139         // Generate the text of a message from its parameters and the current context.
 140         virtual std::string GenText(const std::string& m, int c);
 141
 142         // Returns true if OK to transmit on this frequency
 143         inline bool GetFreqClear() { return freqClear; }
 144         // Indicate that the frequency is in use
 145         inline void SetFreqInUse() { freqClear = false; receiving = true; }
 146         // Transmission to the ATC is finished and a response is required
 147         void SetResponseReqd(const std::string& rid);
 148         // Transmission finished - let ATC decide if a response is reqd and clear freq if necessary
 149         void NotifyTransmissionFinished(const std::string& rid);
 150         // Transmission finished and no response required
 151         inline void ReleaseFreq() { freqClear = true; receiving = false; }      // TODO - check that the plane releasing the freq is the right one etc.
 152         // The above 3 funcs under development!!
 153         // The idea is that AI traffic or the user ATC dialog box calls FreqInUse() when they begin transmitting,
 154         // and that the tower control sets freqClear back to true following a reply.
 155         // AI traffic should check FreqClear() is true prior to transmitting.
 156         // The user will just have to wait for a gap in dialog as in real life.
 157
 158         // Return the type of ATC station that the class represents
 159         inline atc_type GetType() { return _type; }
 160
 161         // Set the core ATC data
 162         void SetData(ATCData* d);
 163
 164         inline int get_freq() const { return freq; }
 165         inline void set_freq(const int fq) {freq = fq;}
 166         inline int get_range() const { return range; }
 167         inline void set_range(const int rg) {range = rg;}
 168         inline const std::string& get_ident() { return ident; }
 169         inline void set_ident(const std::string& id) { ident = id; }
 170         inline const std::string& get_name() { return name; }
 171         inline void set_name(const std::string& nm) { name = nm; }
 172
 173 protected:
 174
 175         // Render a transmission
 176         // Outputs the transmission either on screen or as audio depending on user preference
 177         // The refname is a string to identify this sample to the sound manager
 178         // The repeating flag indicates whether the message should be repeated continuously or played once.
 179         void Render(std::string& msg, const double volume = 1.0,
 180     const std::string& refname = "", bool repeating = false);
 181
 182         // Cease rendering all transmission from this station.
 183         // Requires the sound manager refname if audio, else "".
 184         void NoRender(const std::string& refname);
 185
 186         // Transmit a message when channel becomes free of other dialog
 187     void Transmit(int callback_code = 0);
 188
 189         // Transmit a message if channel becomes free within timeout (seconds). timeout of zero implies no limit
 190         void ConditionalTransmit(double timeout, int callback_code = 0);
 191
 192         // Transmit regardless of other dialog on the channel eg emergency
 193         void ImmediateTransmit(int callback_code = 0);
 194
 195         virtual void ProcessCallback(int code);
 196
 197         SGGeod _geod;
 198         SGVec3d _cart;
 199         int freq;
 200   std::map<std::string,int> active_on;
 201
 202         int range;
 203         std::string ident;              // Code of the airport its at.
 204         std::string name;               // Name transmitted in the broadcast.
 205
 206
 207         // Rendering related stuff
 208         bool _voice;                    // Flag - true if we are using voice
 209         bool _playing;          // Indicates a message in progress
 210         bool _voiceOK;          // Flag - true if at least one voice has loaded OK
 211         FGATCVoice* _vPtr;
 212
 213
 214         bool freqClear;         // Flag to indicate if the frequency is clear of ongoing dialog
 215         bool receiving;         // Flag to indicate we are receiving a transmission
 216
 217
 218         double responseTime;    // Time to take from end of request transmission to beginning of response
 219                                                         // The idea is that this will be slightly random.
 220
 221   bool respond; // Flag to indicate now is the time to respond - ie set following the count down of the response timer.
 222         std::string responseID; // ID of the plane to respond to
 223   bool runResponseCounter;      // Flag to indicate the response counter should be run
 224   double responseCounter;               // counter to implement the above
 225         // Derived classes only need monitor this flag, and use the response ID, as long as they call FGATC::Update(...)
 226         bool _runReleaseCounter;        // A timer for releasing the frequency after giving the message enough time to display
 227   bool responseReqd;    // Flag to indicate we should be responding to a request/report
 228         double _releaseTime;
 229         double _releaseCounter;
 230   atc_type _type;
 231         bool _display;          // Flag to indicate whether we should be outputting to the ATC display.
 232   std::string pending_transmission;     // derived classes set this string before calling Transmit(...)
 233
 234 private:
 235         // Transmission timing stuff.
 236         double _timeout;
 237   bool _pending;
 238
 239         int _callback_code;     // A callback code to be notified and processed by the derived classes
 240                                                 // A value of zero indicates no callback required
 241         bool _transmit;         // we are to transmit
 242         bool _transmitting;     // we are transmitting
 243         double _counter;
 244         double _max_count;
 245 };
 246
 247 std::istream& operator>> ( std::istream& fin, ATCData& a );
 248
 249 #endif  // _FG_ATC_HXX