Add David Culp's AI model manager code which is derived from David Luff's AI/ATC...

[flightgear.git] / src / ATC / commlist.hxx

diff --git a/src/ATC/commlist.hxx b/src/ATC/commlist.hxx
index 033b90afa7a7e6ff50b10ee41e1f31bdc84a7a38..197f0334aad993d27e2ff1c4053129d1650717f9 100644 (file)
--- a/src/ATC/commlist.hxx
+++ b/src/ATC/commlist.hxx
@@ -77,17 +77,28 @@ public:
        // The data found is written into the passed-in ATCData structure.
     bool FindByFreq( double lon, double lat, double elev, double freq, ATCData* ad, atc_type tp = INVALID );
        
-    // query the database by location, lon and lat are
-    // in degrees, elev is in meters
-       // Returns the number of stations of the specified type that are in range, and pushes them into stations
-       // If atc_type is specifed, returns the number of all stations in range, and pushes them into stations
+    // query the database by location, lon and lat are in degrees, elev is in meters, range is in nautical miles.
+       // Returns the number of stations of the specified atc_type tp that are in range of the position defined by 
+       // lon, lat and elev, and pushes them into stations.
+       // If no atc_type is specifed, returns the number of all stations in range, and pushes them into stations
        // ** stations is erased before use **
-    int FindByPos( double lon, double lat, double elev, comm_list_type* stations, atc_type tp = INVALID );
+    int FindByPos( double lon, double lat, double elev, double range, comm_list_type* stations, atc_type tp = INVALID );
+       
+       // Returns the distance in meters to the closest station of a given type,
+       // with the details written into ATCData& ad.  If no type is specifed simply
+       // returns the distance to the closest station of any type.
+       // Returns -9999 if no stations found within max_range in nautical miles (default 100 miles).
+       // Note that the search algorithm starts at 10 miles and multiplies by 10 thereafter, so if
+       // say 300 miles is specifed 10, then 100, then 1000 will be searched, breaking at first result 
+       // and giving up after 1000.
+       // !!!Be warned that searching anything over 100 miles will pause the sim unacceptably!!!
+       //      (The ability to search longer ranges should be used during init only).
+       double FindClosest( double lon, double lat, double elev, ATCData& ad, atc_type tp = INVALID, double max_range = 100.0 );
        
        // Find by Airport code.
        bool FindByCode( string ICAO, ATCData& ad, atc_type tp = INVALID );
 
-    // Return the callsign for an ATIS transmission given transmission time and airpord id
+    // Return the callsign for an ATIS transmission given transmission time and airport id
        // This maybe should get moved somewhere else!!
     int GetCallSign( string apt_id, int hours, int mins );