OpenTTD Source  20241121-master-g67a0fccfad
cargomonitor.cpp
Go to the documentation of this file.
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 
10 #include "stdafx.h"
11 #include "cargomonitor.h"
12 #include "station_base.h"
13 
14 #include "safeguards.h"
15 
18 
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 
48 {
50 }
51 
58 {
60 }
61 
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  monitor_map.emplace(monitor, 0);
75  }
76  return 0;
77  } else {
78  int32_t result = iter->second;
79  iter->second = 0;
80  if (!keep_monitoring) monitor_map.erase(iter);
81  return result;
82  }
83 }
84 
91 int32_t GetDeliveryAmount(CargoMonitorID monitor, bool keep_monitoring)
92 {
93  return GetAmount(_cargo_deliveries, monitor, keep_monitoring);
94 }
95 
103 int32_t GetPickupAmount(CargoMonitorID monitor, bool keep_monitoring)
104 {
105  return GetAmount(_cargo_pickups, monitor, keep_monitoring);
106 }
107 
118 void AddCargoDelivery(CargoID cargo_type, CompanyID company, uint32_t amount, SourceType src_type, SourceID src, const Station *st, IndustryID dest)
119 {
120  if (amount == 0) return;
121 
122  if (src != INVALID_SOURCE) {
123  /* Handle pickup update. */
124  switch (src_type) {
125  case SourceType::Industry: {
126  CargoMonitorID num = EncodeCargoIndustryMonitor(company, cargo_type, src);
127  CargoMonitorMap::iterator iter = _cargo_pickups.find(num);
128  if (iter != _cargo_pickups.end()) iter->second += amount;
129  break;
130  }
131  case SourceType::Town: {
132  CargoMonitorID num = EncodeCargoTownMonitor(company, cargo_type, src);
133  CargoMonitorMap::iterator iter = _cargo_pickups.find(num);
134  if (iter != _cargo_pickups.end()) iter->second += amount;
135  break;
136  }
137  default: break;
138  }
139  }
140 
141  /* Handle delivery.
142  * Note that delivery in the right area is sufficient to prevent trouble with neighbouring industries or houses. */
143 
144  /* Town delivery. */
145  CargoMonitorID num = EncodeCargoTownMonitor(company, cargo_type, st->town->index);
146  CargoMonitorMap::iterator iter = _cargo_deliveries.find(num);
147  if (iter != _cargo_deliveries.end()) iter->second += amount;
148 
149  /* Industry delivery. */
150  for (const auto &i : st->industries_near) {
151  if (i.industry->index != dest) continue;
152  CargoMonitorID num = EncodeCargoIndustryMonitor(company, cargo_type, i.industry->index);
153  CargoMonitorMap::iterator iter = _cargo_deliveries.find(num);
154  if (iter != _cargo_deliveries.end()) iter->second += amount;
155  }
156 }
157 
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
uint16_t SourceID
Contains either industry ID, town ID or company ID (or INVALID_SOURCE)
Definition: cargo_type.h:143
static const SourceID INVALID_SOURCE
Invalid/unknown index of source.
Definition: cargo_type.h:144
SourceType
Types of cargo source and destination.
Definition: cargo_type.h:137
@ Industry
Source/destination is an industry.
@ Town
Source/destination is a town.
void ClearCargoDeliveryMonitoring(CompanyID company)
Clear all delivery cargo monitors.
static void ClearCargoMonitoring(CargoMonitorMap &cargo_monitor_map, CompanyID company=INVALID_OWNER)
Helper method for ClearCargoPickupMonitoring and ClearCargoDeliveryMonitoring.
CargoMonitorMap _cargo_deliveries
Map of monitored deliveries to the amount since last query/activation.
int32_t GetPickupAmount(CargoMonitorID monitor, bool keep_monitoring)
Get the amount of cargo picked up for the given cargo monitor since activation or last query.
int32_t GetDeliveryAmount(CargoMonitorID monitor, bool keep_monitoring)
Get the amount of cargo delivered for the given cargo monitor since activation or last query.
CargoMonitorMap _cargo_pickups
Map of monitored pick-ups to the amount since last query/activation.
void ClearCargoPickupMonitoring(CompanyID company)
Clear all pick-up cargo monitors.
static int32_t GetAmount(CargoMonitorMap &monitor_map, CargoMonitorID monitor, bool keep_monitoring)
Get and reset the amount associated with a cargo monitor.
void AddCargoDelivery(CargoID cargo_type, CompanyID company, uint32_t amount, SourceType src_type, SourceID src, const Station *st, IndustryID dest)
Cargo was delivered to its final destination, update the pickup and delivery maps.
Cargo transport monitoring declarations.
CargoMonitorID EncodeCargoTownMonitor(CompanyID company, CargoID ctype, TownID town)
Encode a cargo monitoring number for pickup or delivery at a town.
Definition: cargomonitor.h:78
uint32_t CargoMonitorID
Unique number for a company / cargo type / (town or industry).
Definition: cargomonitor.h:19
CargoMonitorID EncodeCargoIndustryMonitor(CompanyID company, CargoID ctype, IndustryID ind)
Encode a cargo monitor for pickup or delivery at an industry.
Definition: cargomonitor.h:58
std::map< CargoMonitorID, OverflowSafeInt32 > CargoMonitorMap
Map type for storing and updating active cargo monitor numbers and their amounts.
Definition: cargomonitor.h:32
CompanyID DecodeMonitorCompany(CargoMonitorID num)
Extract the company from the cargo monitor.
Definition: cargomonitor.h:95
Owner
Enum for all companies/owners.
Definition: company_type.h:18
@ INVALID_OWNER
An invalid owner.
Definition: company_type.h:29
A number of safeguards to prevent using unsafe methods.
Base classes/functions for stations.
Definition of base types and functions in a cross-platform compatible way.
Town * town
The town this station is associated with.
Tindex index
Index of this pool item.
Definition: pool_type.hpp:238
Station data structure.
Definition: station_base.h:439
IndustryList industries_near
Cached list of industries near the station that can accept cargo,.
Definition: station_base.h:471