src/Airports/runways.hxx

   1 // runways.hxx -- a simple class to manage airport runway info
   2 //
   3 // Written by Curtis Olson, started August 2000.
   4 //
   5 // Copyright (C) 2000  Curtis L. Olson  - http://www.flightgear.org/~curt
   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 // $Id$
  22
  23
  24 #ifndef _FG_RUNWAYS_HXX
  25 #define _FG_RUNWAYS_HXX
  26
  27 #include <simgear/compiler.h>
  28
  29 #include <Airports/runwaybase.hxx>
  30
  31 // forward decls
  32 class FGAirport;
  33 class FGNavRecord;
  34 class SGPropertyNode;
  35
  36 class FGRunway : public FGRunwayBase
  37 {
  38   FGAirport* _airport;
  39   bool _reciprocal;
  40   double _displ_thresh;
  41   double _stopway;
  42   FGNavRecord* _ils;
  43 public:
  44
  45   FGRunway(FGAirport* aAirport, const std::string& rwy_no,
  46             const SGGeod& aGeod,
  47             const double heading, const double length,
  48             const double width,
  49             const double displ_thresh,
  50             const double stopway,
  51             const int surface_code,
  52             const bool reciprocal);
  53
  54   /**
  55    * given a runway identifier (06, 18L, 31R) compute the identifier for the
  56    * reciprocal heading runway (24, 36R, 13L) string.
  57    */
  58   static std::string reverseIdent(const std::string& aRunayIdent);
  59
  60   /**
  61    * score this runway according to the specified weights. Used by
  62    * FGAirport::findBestRunwayForHeading
  63    */
  64   double score(double aLengthWt, double aWidthWt, double aSurfaceWt) const;
  65
  66   /**
  67    * Test if this runway is the reciprocal. This allows users who iterate
  68    * over runways to avoid counting runways twice, if desired.
  69    */
  70   bool isReciprocal() const
  71   { return _reciprocal; }
  72
  73   /**
  74    * Get the runway begining point - this is syntatic sugar, equivalent to
  75    * calling pointOnCenterline(0.0);
  76    */
  77   SGGeod begin() const;
  78
  79   /**
  80    * Get the (possibly displaced) threshold point.
  81    */
  82   SGGeod threshold() const;
  83
  84   /**
  85    * Get the 'far' end - this is equivalent to calling
  86    * pointOnCenterline(lengthFt());
  87    */
  88   SGGeod end() const;
  89
  90   double displacedThresholdM() const
  91   { return _displ_thresh * SG_FEET_TO_METER; }
  92
  93   double stopwayM() const
  94   { return _stopway * SG_FEET_TO_METER; }
  95
  96   /**
  97    * Airport this runway is located at
  98    */
  99   FGAirport* airport() const
 100   { return _airport; }
 101
 102   // FIXME - should die once airport / runway creation is cleaned up
 103   void setAirport(FGAirport* aAirport)
 104   { _airport = aAirport; }
 105
 106   FGNavRecord* ILS() const { return _ils; }
 107   void setILS(FGNavRecord* nav) { _ils = nav; }
 108
 109   /**
 110    * Helper to process property data loaded from an ICAO.threshold.xml file
 111    */
 112   void processThreshold(SGPropertyNode* aThreshold);
 113 };
 114
 115 #endif // _FG_RUNWAYS_HXX