src/Traffic/Schedule.hxx

   1 /* -*- Mode: C++ -*- *****************************************************
   2  * Schedule.hxx
   3  * Written by Durk Talsma. Started May 5, 2004
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  *
  20  **************************************************************************/
  21
  22 /**************************************************************************
  23  * This file contains the definition of the class Shedule.
  24  *
  25  * A schedule is basically a number of scheduled flights, wich can be
  26  * assigned to an AI aircraft.
  27  **************************************************************************/
  28
  29 #ifndef _FGSCHEDULE_HXX_
  30 #define _FGSCHEDULE_HXX_
  31
  32 #define TRAFFICTOAIDISTTOSTART 150.0
  33 #define TRAFFICTOAIDISTTODIE   200.0
  34
  35
  36 class FGAISchedule
  37 {
  38  private:
  39   string modelPath;
  40   string homePort;
  41   string livery;
  42   string registration;
  43   string airline;
  44   string acType;
  45   string m_class;
  46   string flightType;
  47   string flightIdentifier;
  48   string currentDestination;
  49   bool heavy;
  50   FGScheduledFlightVec flights;
  51   SGGeod position;
  52   double radius;
  53   double groundOffset;
  54   double distanceToUser;
  55   int AIManagerRef;
  56   double score;
  57   unsigned int runCount;
  58   unsigned int hits;
  59   unsigned int lastRun;
  60   bool firstRun;
  61   double courseToDest;
  62   bool initialized;
  63   bool valid;
  64
  65   void scheduleFlights(time_t now);
  66   int groundTimeFromRadius();
  67
  68   /**
  69    * Transition this schedule from distant mode to AI mode;
  70    * create the AIAircraft (and flight plan) and register with the AIManager
  71    */
  72   bool createAIAircraft(FGScheduledFlight* flight, double speedKnots, time_t deptime);
  73
  74  public:
  75   FGAISchedule();                                           // constructor
  76   FGAISchedule(string model,
  77                string livery,
  78                string homePort,
  79                string registration,
  80                string flightId,
  81                bool   heavy,
  82                string acType,
  83                string airline,
  84                string m_class,
  85                string flight_type,
  86                double radius,
  87                double offset);                              // construct & init
  88   FGAISchedule(const FGAISchedule &other);                  // copy constructor
  89
  90
  91
  92   ~FGAISchedule(); //destructor
  93
  94   bool update(time_t now, const SGVec3d& userCart);
  95   bool init();
  96
  97   double getSpeed         ();
  98   //void setClosestDistanceToUser();
  99   bool next();   // forces the schedule to move on to the next flight.
 100
 101   // TODO: rework these four functions
 102    time_t      getDepartureTime    () { return (*flights.begin())->getDepartureTime   (); };
 103   FGAirport * getDepartureAirport () { return (*flights.begin())->getDepartureAirport(); };
 104   FGAirport * getArrivalAirport   () { return (*flights.begin())->getArrivalAirport  (); };
 105   int         getCruiseAlt        () { return (*flights.begin())->getCruiseAlt       (); };
 106   double      getRadius           () { return radius; };
 107   double      getGroundOffset     () { return groundOffset;};
 108   const string& getFlightType     () { return flightType;};
 109   const string& getAirline        () { return airline; };
 110   const string& getAircraft       () { return acType; };
 111   const string& getCallSign       () { return (*flights.begin())->getCallSign (); };
 112   const string& getRegistration   () { return registration;};
 113   const string& getFlightRules    () { return (*flights.begin())->getFlightRules (); };
 114   bool getHeavy                   () { return heavy; };
 115   double getCourse                () { return courseToDest; };
 116   unsigned int getRunCount        () { return runCount; };
 117   unsigned int getHits            () { return hits; };
 118
 119   void         setrunCount(unsigned int count) { runCount = count; };
 120   void         setHits    (unsigned int count) { hits     = count; };
 121   void         setScore   ();
 122   double       getScore   () { return score; };
 123   void         setHeading ();
 124   void         assign         (FGScheduledFlight *ref) { flights.push_back(ref); };
 125   void         setFlightType  (string val            ) { flightType = val; };
 126   FGScheduledFlight*findAvailableFlight (const string &currentDestination, const string &req, time_t min=0, time_t max=0);
 127   // used to sort in decending order of score: I've probably found a better way to
 128   // decending order sorting, but still need to test that.
 129   bool operator< (const FGAISchedule &other) const;
 130     void taint() { valid = false; };
 131     int getLastUsed() { return (int) valid;};
 132     void setLastUsed(unsigned int val) {lastRun = val; };
 133   //void * getAiRef                 () { return AIManagerRef; };
 134   //FGAISchedule* getAddress        () { return this;};
 135
 136 };
 137
 138 typedef vector<FGAISchedule*>           ScheduleVector;
 139 typedef vector<FGAISchedule*>::iterator ScheduleVectorIterator;
 140
 141 bool compareSchedules(FGAISchedule*a, FGAISchedule*b);
 142
 143 #endif
 144