src/Airports/trafficcontrol.hxx

   1 // trafficcontrol.hxx - classes to manage AIModels based air traffic control
   2 // Written by Durk Talsma, started September 2006.
   3 //
   4 // This program is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU General Public License as
   6 // published by the Free Software Foundation; either version 2 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful, but
  10 // WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with this program; if not, write to the Free Software
  16 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17 //
  18 // $Id$
  19
  20
  21 #ifndef _TRAFFIC_CONTROL_HXX_
  22 #define _TRAFFIC_CONTROL_HXX_
  23
  24
  25 #ifndef __cplusplus
  26 # error This library requires C++
  27 #endif
  28
  29
  30 #include <simgear/compiler.h>
  31 #include <simgear/debug/logstream.hxx>
  32
  33
  34 #include STL_STRING
  35 #include <vector>
  36
  37 SG_USING_STD(string);
  38 SG_USING_STD(vector);
  39
  40
  41 typedef vector<int> intVec;
  42 typedef vector<int>::iterator intVecIterator;
  43
  44
  45 class FGAIFlightPlan;  // forward reference
  46 class FGGroundNetwork; // forward reference
  47
  48 /**************************************************************************************
  49  * class FGATCInstruction
  50  * like class FGATC Controller, this class definition should go into its own file
  51  * and or directory... For now, just testing this stuff out though...
  52  *************************************************************************************/
  53 class FGATCInstruction
  54 {
  55 private:
  56   bool holdPattern;
  57   bool holdPosition;
  58   bool changeSpeed;
  59   bool changeHeading;
  60   bool changeAltitude;
  61
  62   double speed;
  63   double heading;
  64   double alt;
  65 public:
  66
  67   FGATCInstruction();
  68   bool hasInstruction   ();
  69   bool getHoldPattern   () { return holdPattern;    };
  70   bool getHoldPosition  () { return holdPosition;   };
  71   bool getChangeSpeed   () { return changeSpeed;    };
  72   bool getChangeHeading () { return changeHeading;  };
  73   bool getChangeAltitude() { return changeAltitude; };
  74
  75   double getSpeed       () { return speed; };
  76   double getHeading     () { return heading; };
  77   double getAlt         () { return alt; };
  78
  79   void setHoldPattern   (bool val) { holdPattern    = val; };
  80   void setHoldPosition  (bool val) { holdPosition   = val; };
  81   void setChangeSpeed   (bool val) { changeSpeed    = val; };
  82   void setChangeHeading (bool val) { changeHeading  = val; };
  83   void setChangeAltitude(bool val) { changeAltitude = val; };
  84
  85   void setSpeed       (double val) { speed   = val; };
  86   void setHeading     (double val) { heading = val; };
  87   void setAlt         (double val) { alt     = val; };
  88 };
  89
  90
  91 /**************************************************************************************
  92  * class FGATCController
  93  * NOTE: this class serves as an abstraction layer for all sorts of ATC controller.
  94  *************************************************************************************/
  95 class FGATCController
  96 {
  97 private:
  98   double dt_count;
  99 public:
 100   FGATCController() { dt_count = 0;};
 101   virtual ~FGATCController() {};
 102   virtual void announcePosition(int id, FGAIFlightPlan *intendedRoute, int currentRoute,
 103                                 double lat, double lon,
 104                                 double hdg, double spd, double alt, double radius, int leg) = 0;
 105   virtual void             signOff(int id) = 0;
 106   virtual void             update(int id, double lat, double lon,
 107                                   double heading, double speed, double alt, double dt) = 0;
 108   virtual bool             hasInstruction(int id) = 0;
 109   virtual FGATCInstruction getInstruction(int id) = 0;
 110
 111   double getDt() { return dt_count; };
 112   void   setDt(double dt) { dt_count = dt;};
 113 };
 114
 115
 116 /**************************************************************************************
 117  * class FGTrafficRecord
 118  *************************************************************************************/
 119 class FGTrafficRecord
 120 {
 121 private:
 122   int id, waitsForId;
 123   int currentPos;
 124   int leg;
 125   intVec intentions;
 126   FGATCInstruction instruction;
 127   double latitude, longitude, heading, speed, altitude, radius;
 128   string runway;
 129
 130
 131 public:
 132   FGTrafficRecord() {};
 133
 134   void setId(int val)  { id = val; };
 135   void setRadius(double rad) { radius = rad;};
 136   void setPositionAndIntentions(int pos, FGAIFlightPlan *route);
 137   void setRunway(string rwy) { runway = rwy;};
 138   void setLeg(int lg) { leg = lg;};
 139   int getId() { return id;};
 140   FGATCInstruction getInstruction() { return instruction;};
 141   bool hasInstruction() { return instruction.hasInstruction(); };
 142   void setPositionAndHeading(double lat, double lon, double hdg, double spd, double alt);
 143   bool checkPositionAndIntentions(FGTrafficRecord &other);
 144   int  crosses                   (FGGroundNetwork *, FGTrafficRecord &other);
 145   bool isOpposing                (FGGroundNetwork *, FGTrafficRecord &other, int node);
 146
 147   bool getSpeedAdjustment() { return instruction.getChangeSpeed(); };
 148
 149   double getLatitude () { return latitude ; };
 150   double getLongitude() { return longitude; };
 151   double getHeading  () { return heading  ; };
 152   double getSpeed    () { return speed    ; };
 153   double getAltitude () { return altitude ; };
 154   double getRadius   () { return radius   ; };
 155
 156   int getWaitsForId  () { return waitsForId; };
 157
 158   void setSpeedAdjustment(double spd);
 159   void setHeadingAdjustment(double heading);
 160   void clearSpeedAdjustment  () { instruction.setChangeSpeed  (false); };
 161   void clearHeadingAdjustment() { instruction.setChangeHeading(false); };
 162
 163   bool hasHeadingAdjustment() { return instruction.getChangeHeading(); };
 164   bool hasHoldPosition() { return instruction.getHoldPosition(); };
 165   void setHoldPosition (bool inst) { instruction.setHoldPosition(inst); };
 166
 167   void setWaitsForId(int id) { waitsForId = id; };
 168
 169   string getRunway() { return runway; };
 170
 171 };
 172
 173 typedef vector<FGTrafficRecord> TrafficVector;
 174 typedef vector<FGTrafficRecord>::iterator TrafficVectorIterator;
 175
 176 /***********************************************************************
 177  * Active runway, a utility class to keep track of which aircraft has
 178  * clearance for a given runway.
 179  **********************************************************************/
 180 class ActiveRunway
 181 {
 182 private:
 183   string rwy;
 184   int currentlyCleared;
 185 public:
 186   ActiveRunway(string r, int cc) { rwy = r; currentlyCleared = cc; };
 187
 188   string getRunwayName() { return rwy; };
 189   int    getCleared   () { return currentlyCleared; };
 190 };
 191
 192 typedef vector<ActiveRunway> ActiveRunwayVec;
 193 typedef vector<ActiveRunway>::iterator ActiveRunwayVecIterator;
 194
 195 /******************************************************************************
 196  * class FGTowerControl
 197  *****************************************************************************/
 198 class FGTowerController : public FGATCController
 199 {
 200 private:
 201   TrafficVector activeTraffic;
 202   ActiveRunwayVec activeRunways;
 203
 204 public:
 205   FGTowerController();
 206   virtual ~FGTowerController() {};
 207   virtual void announcePosition(int id, FGAIFlightPlan *intendedRoute, int currentRoute,
 208                                 double lat, double lon,
 209                                 double hdg, double spd, double alt, double radius, int leg);
 210   virtual void             signOff(int id);
 211   virtual void             update(int id, double lat, double lon,
 212                                   double heading, double speed, double alt, double dt);
 213   virtual bool             hasInstruction(int id);
 214   virtual FGATCInstruction getInstruction(int id);
 215
 216   bool hasActiveTraffic() { return activeTraffic.size() != 0; };
 217   TrafficVector &getActiveTraffic() { return activeTraffic; };
 218 };
 219
 220
 221
 222 #endif // _TRAFFIC_CONTROL_HXX