src/Traffic/TrafficMgr.hxx

   1 /* -*- Mode: C++ -*- *****************************************************
   2  * TrafficMgr.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 class definitions for a (Top Level) traffic
  24  * manager for FlightGear.
  25  *
  26  * This is traffic manager version II. The major difference from version
  27  * I is that the Flight Schedules are decoupled from the AIAircraft
  28  * entities. This allows for a much greater flexibility in setting up
  29  * Irregular schedules. Traffic Manager II also makes no longer use of .xml
  30  * based configuration files.
  31  *
  32  * Here is a step plan to achieve the goal of creating Traffic Manager II
  33  *
  34  * 1) Read aircraft data from a simple text file, like the one provided by
  35  *    Gabor Toth
  36  * 2) Create a new database structure of SchedFlights. This new database
  37  *    should not be part of the Schedule class, but of TrafficManager itself
  38  * 3) Each aircraft should have a list of possible Flights it can operate
  39  *    (i.e. airline and AC type match).
  40  * 4) Aircraft processing proceeds as current. During initialization, we seek
  41  *    the most urgent flight that needs to be operated
  42  * 5) Modify the getNextLeg function so that the next flight is loaded smoothly.
  43
  44  **************************************************************************/
  45
  46 #ifndef _TRAFFICMGR_HXX_
  47 #define _TRAFFICMGR_HXX_
  48
  49 #include <simgear/structure/subsystem_mgr.hxx>
  50 #include <simgear/props/propertyObject.hxx>
  51 #include <simgear/xml/easyxml.hxx>
  52 #include <simgear/misc/sg_path.hxx>
  53 #include <simgear/misc/sg_dir.hxx>
  54
  55 #include "SchedFlight.hxx"
  56 #include "Schedule.hxx"
  57
  58
  59 typedef std::vector<int> IdList;
  60 typedef std::vector<int>::iterator IdListIterator;
  61
  62 class Heuristic
  63 {
  64 public:
  65    std::string registration;
  66    unsigned int runCount;
  67    unsigned int hits;
  68    unsigned int lastRun;
  69 };
  70
  71 typedef std::vector<Heuristic> heuristicsVector;
  72 typedef std::vector<Heuristic>::iterator heuristicsVectorIterator;
  73
  74 typedef std::map < std::string, Heuristic> HeuristicMap;
  75 typedef HeuristicMap::iterator             HeuristicMapIterator;
  76
  77
  78
  79
  80 class FGTrafficManager : public SGSubsystem, public XMLVisitor
  81 {
  82 private:
  83   bool inited;
  84   bool doingInit;
  85
  86   ScheduleVector scheduledAircraft;
  87   ScheduleVectorIterator currAircraft, currAircraftClosest;
  88   vector<string> elementValueStack;
  89
  90   std::string mdl, livery, registration, callsign, fltrules,
  91     port, timeString, departurePort, departureTime, arrivalPort, arrivalTime,
  92     repeat, acType, airline, m_class, flighttype, requiredAircraft, homePort;
  93   int cruiseAlt;
  94   int score, runCount, acCounter;
  95   double radius, offset;
  96   bool heavy;
  97
  98   IdList releaseList;
  99
 100   FGScheduledFlightMap flights;
 101
 102   void readTimeTableFromFile(SGPath infilename);
 103   void Tokenize(const string& str, vector<string>& tokens, const string& delimiters = " ");
 104
 105   simgear::PropertyObject<bool> enabled, aiEnabled, realWxEnabled, metarValid;
 106
 107   void loadHeuristics();
 108
 109   void initStep();
 110   void finishInit();
 111
 112   // during incremental init, contains the XML files still be read in
 113   simgear::PathList schedulesToRead;
 114 public:
 115   FGTrafficManager();
 116   ~FGTrafficManager();
 117   void init();
 118   void update(double time);
 119   void release(int ref);
 120   bool isReleased(int id);
 121
 122   FGScheduledFlightVecIterator getFirstFlight(const string &ref) { return flights[ref].begin(); }
 123   FGScheduledFlightVecIterator getLastFlight(const string &ref) { return flights[ref].end(); }
 124
 125   // Some overloaded virtual XMLVisitor members
 126   virtual void startXML ();
 127   virtual void endXML   ();
 128   virtual void startElement (const char * name, const XMLAttributes &atts);
 129   virtual void endElement (const char * name);
 130   virtual void data (const char * s, int len);
 131   virtual void pi (const char * target, const char * data);
 132   virtual void warning (const char * message, int line, int column);
 133   virtual void error (const char * message, int line, int column);
 134 };
 135
 136 #endif