src/ATC/AIMgr.hxx

   1 // AIMgr.hxx - definition of FGAIMgr
   2 // - a global management class for FlightGear generated AI traffic
   3 //
   4 // Written by David Luff, started March 2002.
   5 //
   6 // Copyright (C) 2002  David C Luff - david.luff@nottingham.ac.uk
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22 #ifndef _FG_AIMGR_HXX
  23 #define _FG_AIMGR_HXX
  24
  25 #include <simgear/structure/subsystem_mgr.hxx>
  26
  27 #include <Main/fg_props.hxx>
  28
  29 #include <list>
  30
  31 #include "ATCmgr.hxx"
  32 #include "AIEntity.hxx"
  33
  34 SG_USING_STD(list);
  35
  36
  37 class FGAIMgr : public SGSubsystem
  38 {
  39
  40 private:
  41         FGATCMgr* ATC;
  42         // This is purely for synactic convienience to avoid writing globals->get_ATC_mgr()-> all through the code!
  43
  44     // A list of pointers to all currently active AI stuff
  45     typedef list <FGAIEntity*> ai_list_type;
  46     typedef ai_list_type::iterator ai_list_iterator;
  47     typedef ai_list_type::const_iterator ai_list_const_iterator;
  48
  49     // Everything put in this list should be created dynamically
  50     // on the heap and ***DELETED WHEN REMOVED!!!!!***
  51     ai_list_type ai_list;
  52     ai_list_iterator ai_list_itr;
  53     // Any member function of FGATCMgr is permitted to leave this iterator pointing
  54     // at any point in or at the end of the list.
  55     // Hence any new access must explicitly first check for atc_list.end() before dereferencing.
  56
  57         // A list of airport or airplane ID's
  58         typedef list < string > ID_list_type;
  59         typedef ID_list_type::iterator ID_list_iterator;
  60
  61         // Temporary storage of ID of planes scheduled for removeal
  62         ID_list_type removalList;
  63
  64         // A map of airport-IDs that have taxiway network files against bucket number
  65         typedef map < int, ID_list_type* > ai_apt_map_type;
  66         typedef ai_apt_map_type::iterator ai_apt_map_iterator;
  67         ai_apt_map_type facilities;
  68
  69         // A map of airport ID's that we've activated AI traffic at
  70         typedef map < string, int > ai_activated_map_type;
  71         typedef ai_activated_map_type::iterator ai_activated_map_iterator;
  72         ai_activated_map_type activated;
  73
  74         // AI traffic lists mapped by airport
  75         typedef map < string, ai_list_type > ai_traffic_map_type;
  76         typedef ai_traffic_map_type::iterator ai_traffic_map_iterator;
  77         ai_traffic_map_type traffic;
  78
  79         // A map of callsigns that we have used (eg CFGFS or N0546D - the code will generate Cessna-four-six-delta from this later)
  80         typedef map < string, int > ai_callsigns_map_type;
  81         typedef ai_callsigns_map_type::iterator ai_callsigns_map_iterator;
  82         ai_callsigns_map_type ai_callsigns_used;
  83
  84     // Position of the Users Aircraft
  85     double lon;
  86     double lat;
  87     double elev;
  88     // Pointers to current users position
  89     SGPropertyNode *lon_node;
  90     SGPropertyNode *lat_node;
  91     SGPropertyNode *elev_node;
  92
  93 public:
  94
  95     FGAIMgr();
  96     ~FGAIMgr();
  97
  98     void init();
  99
 100     void bind();
 101
 102     void unbind();
 103
 104     void update(double dt);
 105
 106         // Signal that it is OK to remove a plane of callsign s
 107         // (To be called by the plane itself).
 108         void ScheduleRemoval(const string& s);
 109
 110 private:
 111
 112         ssgBranch* _defaultModel;  // Cessna 172!
 113         ssgBranch* _piperModel;    // pa28-161
 114
 115         bool initDone;  // Hack - guard against update getting called before init
 116
 117     // Remove a class from the ai_list and delete it from memory
 118     //void RemoveFromList(const char* id, atc_type tp);
 119
 120         // Activate AI traffic at an airport
 121         void ActivateAirport(const string& ident);
 122
 123         // Hack - Generate AI traffic at an airport with no facilities file, with the first plane being at least min_dist out.
 124         void GenerateSimpleAirportTraffic(const string& ident, double min_dist = 0.0);
 125
 126         // Search for valid airports in the vicinity of the user and activate them if necessary
 127         void SearchByPos(double range);
 128
 129         string GenerateCallsign();
 130
 131         string GenerateUniqueCallsign();
 132
 133         string GenerateShortForm(const string& callsign, const string& plane_str = "Cessna-", bool local = false);
 134
 135         // TODO - implement a proper robust system for registering and loading AI GA aircraft models
 136         bool _havePiperModel;
 137 };
 138
 139 #endif  // _FG_AIMGR_HXX