1 /******************************************************************************
3 * Written by Durk Talsma, started May 5, 2004.
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.
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.
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.
20 **************************************************************************/
23 * Traffic manager parses airlines timetable-like data and uses this to
24 * determine the approximate position of each AI aircraft in its database.
25 * When an AI aircraft is close to the user's position, a more detailed
26 * AIModels based simulation is set up.
28 * I'm currently assuming the following simplifications:
29 * 1) The earth is a perfect sphere
30 * 2) Each aircraft flies a perfect great circle route.
31 * 3) Each aircraft flies at a constant speed (with infinite accelerations and
33 * 4) Each aircraft leaves at exactly the departure time.
34 * 5) Each aircraft arrives at exactly the specified arrival time.
37 *****************************************************************************/
53 #include <boost/foreach.hpp>
55 #include <simgear/compiler.h>
56 #include <simgear/misc/sg_path.hxx>
57 #include <simgear/misc/sg_dir.hxx>
58 #include <simgear/props/props.hxx>
59 #include <simgear/structure/subsystem_mgr.hxx>
60 #include <simgear/xml/easyxml.hxx>
61 #include <simgear/threads/SGThread.hxx>
62 #include <simgear/threads/SGGuard.hxx>
64 #include <AIModel/AIAircraft.hxx>
65 #include <AIModel/AIFlightPlan.hxx>
66 #include <AIModel/AIBase.hxx>
67 #include <Airports/simple.hxx>
68 #include <Main/fg_init.hxx>
72 #include "TrafficMgr.hxx"
78 * Thread encapsulating parsing the traffic schedules.
80 class ScheduleParseThread : public SGThread
83 ScheduleParseThread(FGTrafficManager* traffic) :
84 _trafficManager(traffic),
91 // if we're destroyed while running, ensure the thread exits cleanly
92 ~ScheduleParseThread()
96 _cancelThread = true; // request cancellation so we don't wait ages
104 void setTrafficDir(const SGPath& trafficDirPath)
106 _trafficDirPath = trafficDirPath;
109 bool isFinished() const
111 SGGuard<SGMutex> g(_lock);
120 simgear::Dir trafficDir(_trafficDirPath);
121 simgear::PathList d = trafficDir.children(simgear::Dir::TYPE_DIR | simgear::Dir::NO_DOT_OR_DOTDOT);
123 BOOST_FOREACH(SGPath p, d) {
125 simgear::PathList trafficFiles = d2.children(simgear::Dir::TYPE_FILE, ".xml");
126 BOOST_FOREACH(SGPath xml, trafficFiles) {
127 _trafficManager->parseSchedule(xml);
132 } // of sub-directories in AI/Traffic iteration
134 // _trafficManager->parseSchedules(schedulesToRead);
135 SG_LOG(SG_AI, SG_INFO, "parsing traffic schedules took:" << st.elapsedMSec() << "msec");
137 SGGuard<SGMutex> g(_lock);
141 FGTrafficManager* _trafficManager;
142 mutable SGMutex _lock;
145 SGPath _trafficDirPath;
148 /******************************************************************************
150 *****************************************************************************/
151 FGTrafficManager::FGTrafficManager() :
154 waitingMetarTime(0.0),
155 enabled("/sim/traffic-manager/enabled"),
156 aiEnabled("/sim/ai/enabled"),
157 realWxEnabled("/environment/realwx/enabled"),
158 metarValid("/environment/metar/valid")
165 FGTrafficManager::~FGTrafficManager()
170 void FGTrafficManager::shutdown()
174 scheduleParser.reset();
181 // Save the heuristics data
182 bool saveData = false;
184 if (fgGetBool("/sim/traffic-manager/heuristics")) {
185 SGPath cacheData(globals->get_fg_home());
186 cacheData.append("ai");
187 string airport = fgGetString("/sim/presets/airport-id");
189 if ((airport) != "") {
191 ::snprintf(buffer, 128, "%c/%c/%c/",
192 airport[0], airport[1], airport[2]);
193 cacheData.append(buffer);
194 if (!cacheData.exists()) {
195 cacheData.create_dir(0777);
197 cacheData.append(airport + "-cache.txt");
198 //cerr << "Saving AI traffic heuristics" << endl;
200 cachefile.open(cacheData.str().c_str());
201 cachefile << "[TrafficManagerCachedata:ref:2011:09:04]" << endl;
205 BOOST_FOREACH(FGAISchedule* acft, scheduledAircraft) {
207 cachefile << acft->getRegistration() << " "
208 << acft->getRunCount() << " "
209 << acft->getHits() << " "
210 << acft->getLastUsed() << endl;
217 scheduledAircraft.clear();
220 currAircraft = scheduledAircraft.begin();
225 /// caution - this is run on the helper thread to improve startup
226 /// responsiveness - do not access properties or global state from
227 /// here, since there's no locking protection at all
228 void FGTrafficManager::parseSchedule(const SGPath& path)
230 readXML(path.str(), *this);
233 void FGTrafficManager::init()
241 if (string(fgGetString("/sim/traffic-manager/datafile")) == string("")) {
242 scheduleParser.reset(new ScheduleParseThread(this));
243 scheduleParser->setTrafficDir(SGPath(globals->get_fg_root(), "AI/Traffic"));
244 scheduleParser->start();
246 fgSetBool("/sim/traffic-manager/heuristics", false);
247 SGPath path = string(fgGetString("/sim/traffic-manager/datafile"));
248 string ext = path.extension();
249 if (path.extension() == "xml") {
251 readXML(path.str(), *this);
253 } else if (path.extension() == "conf") {
255 readTimeTableFromFile(path);
258 SG_LOG(SG_AI, SG_ALERT,
259 "Unknown data format " << path.str()
268 void FGTrafficManager::finishInit()
271 SG_LOG(SG_AI, SG_INFO, "finishing AI-Traffic init");
274 // Do sorting and scoring separately, to take advantage of the "homeport" variable
275 BOOST_FOREACH(FGAISchedule* schedule, scheduledAircraft) {
276 schedule->setScore();
279 sort(scheduledAircraft.begin(), scheduledAircraft.end(),
281 currAircraft = scheduledAircraft.begin();
282 currAircraftClosest = scheduledAircraft.begin();
288 void FGTrafficManager::loadHeuristics()
290 if (!fgGetBool("/sim/traffic-manager/heuristics")) {
294 HeuristicMap heurMap;
295 //cerr << "Processing Heuristics" << endl;
296 // Load the heuristics data
297 SGPath cacheData(globals->get_fg_home());
298 cacheData.append("ai");
299 string airport = fgGetString("/sim/presets/airport-id");
300 if ((airport) != "") {
302 ::snprintf(buffer, 128, "%c/%c/%c/",
303 airport[0], airport[1], airport[2]);
304 cacheData.append(buffer);
305 cacheData.append(airport + "-cache.txt");
307 if (cacheData.exists()) {
308 ifstream data(cacheData.c_str());
310 if (revisionStr != "[TrafficManagerCachedata:ref:2011:09:04]") {
311 SG_LOG(SG_GENERAL, SG_ALERT,"Traffic Manager Warning: discarding outdated cachefile " <<
312 cacheData.c_str() << " for Airport " << airport);
315 Heuristic h; // = new Heuristic;
316 data >> h.registration >> h.runCount >> h.hits >> h.lastRun;
319 HeuristicMapIterator itr = heurMap.find(h.registration);
320 if (itr != heurMap.end()) {
321 SG_LOG(SG_GENERAL, SG_WARN,"Traffic Manager Warning: found duplicate tailnumber " <<
322 h.registration << " for AI aircraft");
324 heurMap[h.registration] = h;
331 for(currAircraft = scheduledAircraft.begin(); currAircraft != scheduledAircraft.end(); ++currAircraft) {
332 string registration = (*currAircraft)->getRegistration();
333 HeuristicMapIterator itr = heurMap.find(registration);
334 if (itr != heurMap.end()) {
335 (*currAircraft)->setrunCount(itr->second.runCount);
336 (*currAircraft)->setHits(itr->second.hits);
337 (*currAircraft)->setLastUsed(itr->second.lastRun);
342 bool FGTrafficManager::metarReady(double dt)
344 // wait for valid METAR (when realWX is enabled only), since we need
345 // to know the active runway
346 if (metarValid || !realWxEnabled)
348 waitingMetarTime = 0.0;
352 // METAR timeout: when running offline, remote server is down etc
353 if (waitingMetarStation != fgGetString("/environment/metar/station-id"))
355 // station has changed: wait for reply, restart timeout
356 waitingMetarTime = 0.0;
357 waitingMetarStation = fgGetString("/environment/metar/station-id");
361 // timeout elapsed (10 seconds)?
362 if (waitingMetarTime > 20.0)
367 waitingMetarTime += dt;
371 void FGTrafficManager::update(double dt)
375 if (inited || doingInit)
385 // traffic depends on AI module
394 if (!scheduleParser->isFinished()) {
401 time_t now = time(NULL) + fgGetLong("/sim/time/warp");
402 if (scheduledAircraft.empty()) {
406 SGVec3d userCart = globals->get_aircraft_position_cart();
408 if (currAircraft == scheduledAircraft.end()) {
409 currAircraft = scheduledAircraft.begin();
411 //cerr << "Processing << " << (*currAircraft)->getRegistration() << " with score " << (*currAircraft)->getScore() << endl;
412 if (!((*currAircraft)->update(now, userCart))) {
413 (*currAircraft)->taint();
418 void FGTrafficManager::readTimeTableFromFile(SGPath infileName)
435 vector <string> tokens, depTime,arrTime;
436 vector <string>::iterator it;
437 ifstream infile(infileName.str().c_str());
439 infile.getline(buffer, 256);
443 //cerr << "Read line : " << buffer << endl;
444 buffString = string(buffer);
446 Tokenize(buffString, tokens, " \t");
447 //for (it = tokens.begin(); it != tokens.end(); it++) {
448 // cerr << "Tokens: " << *(it) << endl;
451 if (!tokens.empty()) {
452 if (tokens[0] == string("AC")) {
453 if (tokens.size() != 13) {
454 SG_LOG(SG_GENERAL, SG_ALERT, "Error parsing traffic file " << infileName.str() << " at " << buffString);
459 homePort = tokens[1];
460 registration = tokens[2];
461 if (tokens[11] == string("false")) {
468 flightReq = tokens[3] + tokens[5];
469 m_class = tokens[10];
470 FlightType = tokens[9];
471 radius = atof(tokens[8].c_str());
472 offset = atof(tokens[7].c_str());;
474 if (!FGAISchedule::validModelPath(model)) {
475 SG_LOG(SG_GENERAL, SG_WARN, "TrafficMgr: Missing model path:" <<
476 model << " from " << infileName.str());
479 SG_LOG(SG_GENERAL, SG_INFO, "Adding Aircraft" << model << " " << livery << " " << homePort << " "
480 << registration << " " << flightReq << " " << isHeavy
481 << " " << acType << " " << airline << " " << m_class
482 << " " << FlightType << " " << radius << " " << offset);
483 scheduledAircraft.push_back(new FGAISchedule(model,
495 } // of valid model path
497 if (tokens[0] == string("FLIGHT")) {
498 //cerr << "Found flight " << buffString << " size is : " << tokens.size() << endl;
499 if (tokens.size() != 10) {
500 SG_LOG(SG_GENERAL, SG_ALERT, "Error parsing traffic file " << infileName.str() << " at " << buffString);
503 string callsign = tokens[1];
504 string fltrules = tokens[2];
505 string weekdays = tokens[3];
506 string departurePort = tokens[5];
507 string arrivalPort = tokens[7];
508 int cruiseAlt = atoi(tokens[8].c_str());
509 string depTimeGen = tokens[4];
510 string arrTimeGen = tokens[6];
511 string repeat = "WEEK";
512 string requiredAircraft = tokens[9];
514 if (weekdays.size() != 7) {
515 SG_LOG(SG_GENERAL, SG_ALERT, "Found misconfigured weekdays string" << weekdays);
520 Tokenize(depTimeGen, depTime, ":");
521 Tokenize(arrTimeGen, arrTime, ":");
522 double dep = atof(depTime[0].c_str()) + (atof(depTime[1].c_str()) / 60.0);
523 double arr = atof(arrTime[0].c_str()) + (atof(arrTime[1].c_str()) / 60.0);
524 //cerr << "Using " << dep << " " << arr << endl;
525 bool arrivalWeekdayNeedsIncrement = false;
527 arrivalWeekdayNeedsIncrement = true;
529 for (int i = 0; i < 7; i++) {
531 if (weekdays[i] != '.') {
533 snprintf(buffer, 4, "%d/", j);
534 string departureTime = string(buffer) + depTimeGen + string(":00");
536 if (!arrivalWeekdayNeedsIncrement) {
537 arrivalTime = string(buffer) + arrTimeGen + string(":00");
539 if (arrivalWeekdayNeedsIncrement && i != 6 ) {
540 snprintf(buffer, 4, "%d/", j+1);
541 arrivalTime = string(buffer) + arrTimeGen + string(":00");
543 if (arrivalWeekdayNeedsIncrement && i == 6 ) {
544 snprintf(buffer, 4, "%d/", 0);
545 arrivalTime = string(buffer) + arrTimeGen + string(":00");
547 SG_LOG(SG_GENERAL, SG_ALERT, "Adding flight " << callsign << " "
549 << departurePort << " "
550 << arrivalPort << " "
552 << departureTime << " "
553 << arrivalTime << " "
555 << requiredAircraft);
557 flights[requiredAircraft].push_back(new FGScheduledFlight(callsign,
576 void FGTrafficManager::Tokenize(const string& str,
577 vector<string>& tokens,
578 const string& delimiters)
580 // Skip delimiters at beginning.
581 string::size_type lastPos = str.find_first_not_of(delimiters, 0);
582 // Find first "non-delimiter".
583 string::size_type pos = str.find_first_of(delimiters, lastPos);
585 while (string::npos != pos || string::npos != lastPos)
587 // Found a token, add it to the vector.
588 tokens.push_back(str.substr(lastPos, pos - lastPos));
589 // Skip delimiters. Note the "not_of"
590 lastPos = str.find_first_not_of(delimiters, pos);
591 // Find next "non-delimiter"
592 pos = str.find_first_of(delimiters, lastPos);
597 void FGTrafficManager::startXML()
599 //cout << "Start XML" << endl;
600 requiredAircraft = "";
604 void FGTrafficManager::endXML()
606 //cout << "End XML" << endl;
609 void FGTrafficManager::startElement(const char *name,
610 const XMLAttributes & atts)
613 //cout << "Start element " << name << endl;
614 //FGTrafficManager temp;
615 //for (int i = 0; i < atts.size(); i++)
616 // if (string(atts.getName(i)) == string("include"))
617 attval = atts.getValue("include");
619 //cout << "including " << attval << endl;
620 SGPath path = globals->get_fg_root();
621 path.append("/Traffic/");
623 readXML(path.str(), *this);
625 elementValueStack.push_back("");
626 // cout << " " << atts.getName(i) << '=' << atts.getValue(i) << endl;
629 void FGTrafficManager::endElement(const char *name)
631 //cout << "End element " << name << endl;
632 const string & value = elementValueStack.back();
634 if (!strcmp(name, "model"))
636 else if (!strcmp(name, "livery"))
638 else if (!strcmp(name, "home-port"))
640 else if (!strcmp(name, "registration"))
641 registration = value;
642 else if (!strcmp(name, "airline"))
644 else if (!strcmp(name, "actype"))
646 else if (!strcmp(name, "required-aircraft"))
647 requiredAircraft = value;
648 else if (!strcmp(name, "flighttype"))
650 else if (!strcmp(name, "radius"))
651 radius = atoi(value.c_str());
652 else if (!strcmp(name, "offset"))
653 offset = atoi(value.c_str());
654 else if (!strcmp(name, "performance-class"))
656 else if (!strcmp(name, "heavy")) {
657 if (value == string("true"))
661 } else if (!strcmp(name, "callsign"))
663 else if (!strcmp(name, "fltrules"))
665 else if (!strcmp(name, "port"))
667 else if (!strcmp(name, "time"))
669 else if (!strcmp(name, "departure")) {
670 departurePort = port;
671 departureTime = timeString;
672 } else if (!strcmp(name, "cruise-alt"))
673 cruiseAlt = atoi(value.c_str());
674 else if (!strcmp(name, "arrival")) {
676 arrivalTime = timeString;
677 } else if (!strcmp(name, "repeat"))
679 else if (!strcmp(name, "flight")) {
680 // We have loaded and parsed all the information belonging to this flight
681 // so we temporarily store it.
682 //cerr << "Pusing back flight " << callsign << endl;
683 //cerr << callsign << " " << fltrules << " "<< departurePort << " " << arrivalPort << " "
684 // << cruiseAlt << " " << departureTime<< " "<< arrivalTime << " " << repeat << endl;
686 //Prioritize aircraft
687 string apt = fgGetString("/sim/presets/airport-id");
688 //cerr << "Airport information: " << apt << " " << departurePort << " " << arrivalPort << endl;
689 //if (departurePort == apt) score++;
690 //flights.push_back(new FGScheduledFlight(callsign,
698 if (requiredAircraft == "") {
700 snprintf(buffer, 16, "%d", acCounter);
701 requiredAircraft = buffer;
703 SG_LOG(SG_GENERAL, SG_DEBUG, "Adding flight: " << callsign << " "
705 << departurePort << " "
706 << arrivalPort << " "
708 << departureTime << " "
709 << arrivalTime << " " << repeat << " " << requiredAircraft);
710 // For database maintainance purposes, it may be convenient to
712 if (fgGetBool("/sim/traffic-manager/dumpdata") == true) {
713 SG_LOG(SG_GENERAL, SG_ALERT, "Traffic Dump FLIGHT," << callsign << ","
715 << departurePort << ","
716 << arrivalPort << ","
718 << departureTime << ","
719 << arrivalTime << "," << repeat << "," << requiredAircraft);
721 flights[requiredAircraft].push_back(new FGScheduledFlight(callsign,
730 requiredAircraft = "";
731 } else if (!strcmp(name, "aircraft")) {
735 elementValueStack.pop_back();
738 void FGTrafficManager::endAircraft()
740 string isHeavy = heavy ? "true" : "false";
742 if (missingModels.find(mdl) != missingModels.end()) {
743 // don't stat() or warn again
744 requiredAircraft = homePort = "";
748 if (!FGAISchedule::validModelPath(mdl)) {
749 missingModels.insert(mdl);
750 SG_LOG(SG_GENERAL, SG_WARN, "TrafficMgr: Missing model path:" << mdl);
751 requiredAircraft = homePort = "";
756 (int) (fgGetDouble("/sim/traffic-manager/proportion") * 100);
757 int randval = rand() & 100;
758 if (randval > proportion) {
759 requiredAircraft = homePort = "";
763 if (fgGetBool("/sim/traffic-manager/dumpdata") == true) {
764 SG_LOG(SG_GENERAL, SG_ALERT, "Traffic Dump AC," << homePort << "," << registration << "," << requiredAircraft
765 << "," << acType << "," << livery << ","
766 << airline << "," << m_class << "," << offset << "," << radius << "," << flighttype << "," << isHeavy << "," << mdl);
769 if (requiredAircraft == "") {
771 snprintf(buffer, 16, "%d", acCounter);
772 requiredAircraft = buffer;
774 if (homePort == "") {
775 homePort = departurePort;
778 scheduledAircraft.push_back(new FGAISchedule(mdl,
791 requiredAircraft = "";
796 void FGTrafficManager::data(const char *s, int len)
798 string token = string(s, len);
799 //cout << "Character data " << string(s,len) << endl;
800 elementValueStack.back() += token;
803 void FGTrafficManager::pi(const char *target, const char *data)
805 //cout << "Processing instruction " << target << ' ' << data << endl;
808 void FGTrafficManager::warning(const char *message, int line, int column)
810 SG_LOG(SG_IO, SG_WARN,
811 "Warning: " << message << " (" << line << ',' << column << ')');
814 void FGTrafficManager::error(const char *message, int line, int column)
816 SG_LOG(SG_IO, SG_ALERT,
817 "Error: " << message << " (" << line << ',' << column << ')');