src/cargomonitor.cpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file cargomonitor.cpp Implementation of the cargo transport monitoring. */
   9
  10 #include "stdafx.h"
  11 #include "cargomonitor.h"
  12 #include "station_base.h"
  13
  14 #include "safeguards.h"
  15
  16 CargoMonitorMap _cargo_pickups;    ///< Map of monitored pick-ups   to the amount since last query/activation.
  17 CargoMonitorMap _cargo_deliveries; ///< Map of monitored deliveries to the amount since last query/activation.
  18
  19 /**
  20  * Helper method for #ClearCargoPickupMonitoring and #ClearCargoDeliveryMonitoring.
  21  * Clears all monitors that belong to the specified company or all if #INVALID_OWNER
  22  * is specified as company.
  23  * @param cargo_monitor_map reference to the cargo monitor map to operate on.
  24  * @param company company to clear cargo monitors for or #INVALID_OWNER if all cargo monitors should be cleared.
  25  */
  26 static void ClearCargoMonitoring(CargoMonitorMap &cargo_monitor_map, CompanyID company = INVALID_OWNER)
  27 {
  28         if (company == INVALID_OWNER) {
  29                 cargo_monitor_map.clear();
  30                 return;
  31         }
  32
  33         for (auto it = cargo_monitor_map.begin(); it != cargo_monitor_map.end(); /* nothing */) {
  34                 if (DecodeMonitorCompany(it->first) == company) {
  35                         it = cargo_monitor_map.erase(it);
  36                 } else {
  37                         ++it;
  38                 }
  39         }
  40 }
  41
  42 /**
  43  * Clear all pick-up cargo monitors.
  44  * @param company clear all pick-up monitors for this company or if #INVALID_OWNER
  45  * is passed, all pick-up monitors are cleared regardless of company.
  46  */
  47 void ClearCargoPickupMonitoring(CompanyID company)
  48 {
  49         ClearCargoMonitoring(_cargo_pickups, company);
  50 }
  51
  52 /**
  53  * Clear all delivery cargo monitors.
  54  * @param company clear all delivery monitors for this company or if #INVALID_OWNER
  55  * is passed, all delivery monitors are cleared regardless of company.
  56  */
  57 void ClearCargoDeliveryMonitoring(CompanyID company)
  58 {
  59         ClearCargoMonitoring(_cargo_deliveries, company);
  60 }
  61
  62 /**
  63  * Get and reset the amount associated with a cargo monitor.
  64  * @param[in,out] monitor_map Monitoring map to search (and reset for the queried entry).
  65  * @param monitor Cargo monitor to query/reset.
  66  * @param keep_monitoring After returning from this call, continue monitoring.
  67  * @return Amount collected since last query/activation for the monitored combination.
  68  */
  69 static int32_t GetAmount(CargoMonitorMap &monitor_map, CargoMonitorID monitor, bool keep_monitoring)
  70 {
  71         CargoMonitorMap::iterator iter = monitor_map.find(monitor);
  72         if (iter == monitor_map.end()) {
  73                 if (keep_monitoring) {
  74                         std::pair<CargoMonitorID, uint32_t> p(monitor, 0);
  75                         monitor_map.insert(p);
  76                 }
  77                 return 0;
  78         } else {
  79                 int32_t result = iter->second;
  80                 iter->second = 0;
  81                 if (!keep_monitoring) monitor_map.erase(iter);
  82                 return result;
  83         }
  84 }
  85
  86 /**
  87  * Get the amount of cargo delivered for the given cargo monitor since activation or last query.
  88  * @param monitor Cargo monitor to query.
  89  * @param keep_monitoring After returning from this call, continue monitoring.
  90  * @return Amount of delivered cargo for the monitored combination.
  91  */
  92 int32_t GetDeliveryAmount(CargoMonitorID monitor, bool keep_monitoring)
  93 {
  94         return GetAmount(_cargo_deliveries, monitor, keep_monitoring);
  95 }
  96
  97 /**
  98  * Get the amount of cargo picked up for the given cargo monitor since activation or last query.
  99  * @param monitor Monitoring number to query.
 100  * @param keep_monitoring After returning from this call, continue monitoring.
 101  * @return Amount of picked up cargo for the monitored combination.
 102  * @note Cargo pick up is counted on final delivery, to prevent users getting credit for picking up cargo without delivering it.
 103  */
 104 int32_t GetPickupAmount(CargoMonitorID monitor, bool keep_monitoring)
 105 {
 106         return GetAmount(_cargo_pickups, monitor, keep_monitoring);
 107 }
 108
 109 /**
 110  * Cargo was delivered to its final destination, update the pickup and delivery maps.
 111  * @param cargo_type type of cargo.
 112  * @param company company delivering the cargo.
 113  * @param amount Amount of cargo delivered.
 114  * @param src_type type of \a src.
 115  * @param src index of source.
 116  * @param st station where the cargo is delivered to.
 117  * @param dest industry index where the cargo is delivered to.
 118  */
 119 void AddCargoDelivery(CargoID cargo_type, CompanyID company, uint32_t amount, SourceType src_type, SourceID src, const Station *st, IndustryID dest)
 120 {
 121         if (amount == 0) return;
 122
 123         if (src != INVALID_SOURCE) {
 124                 /* Handle pickup update. */
 125                 switch (src_type) {
 126                         case SourceType::Industry: {
 127                                 CargoMonitorID num = EncodeCargoIndustryMonitor(company, cargo_type, src);
 128                                 CargoMonitorMap::iterator iter = _cargo_pickups.find(num);
 129                                 if (iter != _cargo_pickups.end()) iter->second += amount;
 130                                 break;
 131                         }
 132                         case SourceType::Town: {
 133                                 CargoMonitorID num = EncodeCargoTownMonitor(company, cargo_type, src);
 134                                 CargoMonitorMap::iterator iter = _cargo_pickups.find(num);
 135                                 if (iter != _cargo_pickups.end()) iter->second += amount;
 136                                 break;
 137                         }
 138                         default: break;
 139                 }
 140         }
 141
 142         /* Handle delivery.
 143          * Note that delivery in the right area is sufficient to prevent trouble with neighbouring industries or houses. */
 144
 145         /* Town delivery. */
 146         CargoMonitorID num = EncodeCargoTownMonitor(company, cargo_type, st->town->index);
 147         CargoMonitorMap::iterator iter = _cargo_deliveries.find(num);
 148         if (iter != _cargo_deliveries.end()) iter->second += amount;
 149
 150         /* Industry delivery. */
 151         for (const auto &i : st->industries_near) {
 152                 if (i.industry->index != dest) continue;
 153                 CargoMonitorID num = EncodeCargoIndustryMonitor(company, cargo_type, i.industry->index);
 154                 CargoMonitorMap::iterator iter = _cargo_deliveries.find(num);
 155                 if (iter != _cargo_deliveries.end()) iter->second += amount;
 156         }
 157 }
 158