src/cargomonitor.cpp

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