src/ATCDCL/AIPlane.hxx

   1 // FGAIPlane - abstract base class for an AI plane
   2 //
   3 // Written by David Luff, started 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifndef _FG_AI_PLANE_HXX
  22 #define _FG_AI_PLANE_HXX
  23
  24 #include "AIEntity.hxx"
  25 #include "ATC.hxx"
  26
  27 enum PatternLeg {
  28         TAKEOFF_ROLL,
  29         CLIMBOUT,
  30         TURN1,
  31         CROSSWIND,
  32         TURN2,
  33         DOWNWIND,
  34         TURN3,
  35         BASE,
  36         TURN4,
  37         FINAL,
  38         LANDING_ROLL,
  39         LEG_UNKNOWN
  40 };
  41
  42 ostream& operator << (ostream& os, PatternLeg pl);
  43
  44 enum LandingType {
  45         FULL_STOP,
  46         STOP_AND_GO,
  47         TOUCH_AND_GO,
  48         AIP_LT_UNKNOWN
  49 };
  50
  51 ostream& operator << (ostream& os, LandingType lt);
  52
  53 /*****************************************************************
  54 *
  55 *  FGAIPlane - this class is derived from FGAIEntity and adds the
  56 *  practical requirement for an AI plane - the ability to send radio
  57 *  communication, and simple performance details for the actual AI
  58 *  implementation to use.  The AI implementation is expected to be
  59 *  in derived classes - this class does nothing useful on its own.
  60 *
  61 ******************************************************************/
  62 class FGAIPlane : public FGAIEntity {
  63
  64 public:
  65
  66         FGAIPlane();
  67     virtual ~FGAIPlane();
  68
  69     // Run the internal calculations
  70         void Update(double dt);
  71
  72         // Send a transmission *TO* the AIPlane.
  73         // FIXME int code is a hack - eventually this will receive Alexander's coded messages.
  74         virtual void RegisterTransmission(int code);
  75
  76         // Return the current pattern leg the plane is flying.
  77         inline PatternLeg GetLeg() {return leg;}
  78
  79         // Return what type of landing we're doing on this circuit
  80         virtual LandingType GetLandingOption();
  81
  82         // Return the callsign
  83         inline const string& GetCallsign() {return plane.callsign;}
  84
  85 protected:
  86         PlaneRec plane;
  87
  88     double mag_hdg;     // degrees - the heading that the physical aircraft is *pointing*
  89     double track;       // track that the physical aircraft is *following* - degrees relative to *true* north
  90     double crab;        // Difference between heading and track due to wind.
  91     double mag_var;     // degrees
  92     double IAS;         // Indicated airspeed in knots
  93     double vel;         // velocity along track in knots
  94     double vel_si;      // velocity along track in m/s
  95     double slope;       // Actual slope that the plane is flying (degrees) - +ve is uphill
  96     double AoA;         // degrees - difference between slope and pitch
  97     // We'll assume that the plane doesn't yaw or slip - the track/heading difference is to allow for wind
  98
  99     double freq;        // The comm frequency that we're operating on
 100
 101     // We need some way for this class to display its radio transmissions if on the
 102     // same frequency and in the vicinity of the user's aircraft
 103     // This may need to be done independently of ATC eg CTAF
 104     // Make radio transmission - this simply sends the transmission for physical rendering if the users
 105     // aircraft is on the same frequency and in range.  It is up to the derived classes to let ATC know
 106     // what is going on.
 107         string pending_transmission;    // derived classes set this string before calling Transmit(...)
 108         FGATC* tuned_station;                   // and this if they are tuned to ATC
 109
 110         // Transmit a message when channel becomes free of other dialog
 111     void Transmit(int callback_code = 0);
 112
 113         // Transmit a message if channel becomes free within timeout (seconds). timeout of zero implies no limit
 114         void ConditionalTransmit(double timeout, int callback_code = 0);
 115
 116         // Transmit regardless of other dialog on the channel eg emergency
 117         void ImmediateTransmit(int callback_code = 0);
 118
 119         inline void SetTrack(double t) { _tgtTrack = t; _trackSet = true; }
 120         inline void ClearTrack() { _trackSet = false; }
 121
 122     inline void Bank(double r) { _tgtRoll = r; }
 123     inline void LevelWings(void) { _tgtRoll = 0.0; }
 124
 125         virtual void ProcessCallback(int code);
 126
 127         PatternLeg leg;
 128
 129 private:
 130         bool _pending;
 131         double _timeout;
 132         int _callback_code;     // A callback code to be notified and processed by the derived classes
 133                                                 // A value of zero indicates no callback required
 134         bool _transmit;         // we are to transmit
 135         bool _transmitting;     // we are transmitting
 136         double _counter;
 137         double _max_count;
 138
 139         // Render a transmission (in string pending_transmission)
 140         // Outputs the transmission either on screen or as audio depending on user preference
 141         // The refname is a string to identify this sample to the sound manager
 142         // The repeating flag indicates whether the message should be repeated continuously or played once.
 143         void Render(const string& refname, bool repeating);
 144
 145         // Cease rendering a transmission.
 146         // Requires the sound manager refname if audio, else "".
 147         void NoRender(const string& refname);
 148
 149         // Rendering related stuff
 150         bool voice;                     // Flag - true if we are using voice
 151         bool playing;           // Indicates a message in progress
 152         bool voiceOK;           // Flag - true if at least one voice has loaded OK
 153         FGATCVoice* vPtr;
 154
 155         // Navigation
 156         double _tgtTrack;       // Track to be following if _trackSet is true
 157         bool _trackSet;         // Set true if tgtTrack is to be followed
 158         double _tgtRoll;
 159         bool _rollSuspended;    // Set true when a derived class has suspended AIPlane's roll control
 160 };
 161
 162 #endif  // _FG_AI_PLANE_HXX
 163