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