Files
@ r13962:aec40147ce1d
Branch filter:
Location: cpp/openttd-patchpack/source/src/cargopacket.h - annotation
r13962:aec40147ce1d
13.2 KiB
text/x-c
(svn r18510) -Codechange: some further cleanups of the Windows installer; it didn't always remove all the files it installed and the downloaded free graphics/sounds are now fully extracted instead of dumped as tar in the data directory. This should make reading the readme for them quite a bit easier.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r11969:3526c3cc75dc r8119:8fdb3a371896 r8237:d8e599249043 r8769:6c1f27d01bf5 r12648:24c912bd53f6 r13217:a7416accbcb8 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13210:6ef3c7aaa995 r7380:61767264770c r7380:61767264770c r7380:61767264770c r13210:6ef3c7aaa995 r13321:c47f247ca684 r13210:6ef3c7aaa995 r11967:df0600d2c7e7 r7380:61767264770c r13281:e10563871a55 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r11967:df0600d2c7e7 r13203:2e49af5aeba4 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r7010:fd8e3ec6f727 r13203:2e49af5aeba4 r13281:e10563871a55 r13276:3604b09589ee r13276:3604b09589ee r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13204:037e2fceda8f r13204:037e2fceda8f r13203:2e49af5aeba4 r7010:fd8e3ec6f727 r13317:40d17c38b14e r13317:40d17c38b14e r13317:40d17c38b14e r13317:40d17c38b14e r13317:40d17c38b14e r7010:fd8e3ec6f727 r13317:40d17c38b14e r13317:40d17c38b14e r13203:2e49af5aeba4 r13060:e57594b0ca84 r13203:2e49af5aeba4 r13317:40d17c38b14e r7010:fd8e3ec6f727 r13317:40d17c38b14e r7010:fd8e3ec6f727 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13288:93fbc02f05b0 r13288:93fbc02f05b0 r13288:93fbc02f05b0 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13288:93fbc02f05b0 r13203:2e49af5aeba4 r7010:fd8e3ec6f727 r11967:df0600d2c7e7 r7010:fd8e3ec6f727 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13203:2e49af5aeba4 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13289:26a0ed664dc0 r13203:2e49af5aeba4 r12648:24c912bd53f6 r13285:765ad409980c r13287:52547c48c3ba r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r11966:921bea0ca112 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r11966:921bea0ca112 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r11966:921bea0ca112 r7010:fd8e3ec6f727 r11966:921bea0ca112 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13281:e10563871a55 r7010:fd8e3ec6f727 r13281:e10563871a55 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13294:1c7a8cd8e77d r7010:fd8e3ec6f727 r13294:1c7a8cd8e77d r13294:1c7a8cd8e77d r13294:1c7a8cd8e77d r13294:1c7a8cd8e77d r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r12269:f94731e7dc53 r12269:f94731e7dc53 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13276:3604b09589ee r13216:2c9a757db2cc r13216:2c9a757db2cc r7010:fd8e3ec6f727 r13216:2c9a757db2cc r13215:922f97d8d59c r13218:a349a5df045c r13218:a349a5df045c r13318:d50edc24e40a r13218:a349a5df045c r13218:a349a5df045c r13218:a349a5df045c r13218:a349a5df045c r13218:a349a5df045c r13218:a349a5df045c r13318:d50edc24e40a r13218:a349a5df045c r13218:a349a5df045c r13218:a349a5df045c r13218:a349a5df045c r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13295:dd56059817bc r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13281:e10563871a55 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r13214:4d6bd80fcf2a r13210:6ef3c7aaa995 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r13214:4d6bd80fcf2a r13210:6ef3c7aaa995 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13210:6ef3c7aaa995 r13210:6ef3c7aaa995 r13216:2c9a757db2cc r13210:6ef3c7aaa995 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13219:41299110cd66 r7010:fd8e3ec6f727 r13219:41299110cd66 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r12269:f94731e7dc53 r12269:f94731e7dc53 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r12269:f94731e7dc53 r12269:f94731e7dc53 r12269:f94731e7dc53 r12269:f94731e7dc53 r12269:f94731e7dc53 r12269:f94731e7dc53 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13281:e10563871a55 r13290:9954cbdc2063 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r7010:fd8e3ec6f727 r13276:3604b09589ee r13276:3604b09589ee r13276:3604b09589ee r13281:e10563871a55 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13276:3604b09589ee r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13276:3604b09589ee r13276:3604b09589ee r13276:3604b09589ee r13276:3604b09589ee r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13276:3604b09589ee r13276:3604b09589ee r13276:3604b09589ee r13282:5abfbbdbe99a r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13276:3604b09589ee r13276:3604b09589ee r13276:3604b09589ee r13276:3604b09589ee r13276:3604b09589ee r13281:e10563871a55 r13276:3604b09589ee r13293:58ebfc85fa07 r13293:58ebfc85fa07 r13276:3604b09589ee r13276:3604b09589ee r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13282:5abfbbdbe99a r13276:3604b09589ee r13276:3604b09589ee r7010:fd8e3ec6f727 | /* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file cargopacket.h Base class for cargo packets. */
#ifndef CARGOPACKET_H
#define CARGOPACKET_H
#include "core/pool_type.hpp"
#include "economy_type.h"
#include "tile_type.h"
#include "station_type.h"
#include "cargo_type.h"
#include "vehicle_type.h"
#include <list>
/** Unique identifier for a single cargo packet. */
typedef uint32 CargoPacketID;
struct CargoPacket;
/** Type of the pool for cargo packets. */
typedef Pool<CargoPacket, CargoPacketID, 1024, 1048576, true, false> CargoPacketPool;
/** The actual pool with cargo packets */
extern CargoPacketPool _cargopacket_pool;
template <class Tinst> class CargoList;
extern const struct SaveLoad *GetCargoPacketDesc();
/**
* Container for cargo from the same location and time
*/
struct CargoPacket : CargoPacketPool::PoolItem<&_cargopacket_pool> {
private:
Money feeder_share; ///< Value of feeder pickup to be paid for on delivery of cargo
uint16 count; ///< The amount of cargo in this packet
byte days_in_transit; ///< Amount of days this packet has been in transit
SourceTypeByte source_type; ///< Type of \c source_id
SourceID source_id; ///< Index of source, INVALID_SOURCE if unknown/invalid
StationID source; ///< The station where the cargo came from first
TileIndex source_xy; ///< The origin of the cargo (first station in feeder chain)
TileIndex loaded_at_xy; ///< Location where this cargo has been loaded into the vehicle
/** The CargoList caches, thus needs to know about it. */
template <class Tinst> friend class CargoList;
friend class VehicleCargoList;
friend class StationCargoList;
/** We want this to be saved, right? */
friend const struct SaveLoad *GetCargoPacketDesc();
public:
/** Maximum number of items in a single cargo packet. */
static const uint16 MAX_COUNT = UINT16_MAX;
/**
* Create a new packet for savegame loading.
*/
CargoPacket();
/**
* Creates a new cargo packet
* @param source the source station of the packet
* @param source_xy the source location of the packet
* @param count the number of cargo entities to put in this packet
* @param source_type the 'type' of source the packet comes from (for subsidies)
* @param source_id the actual source of the packet (for subsidies)
* @pre count != 0
*/
CargoPacket(StationID source, TileIndex source_xy, uint16 count, SourceType source_type, SourceID source_id);
/**
* Creates a new cargo packet. Initializes the fields that cannot be changed later.
* Used when loading or splitting packets.
* @param count the number of cargo entities to put in this packet
* @param days_in_transit number of days the cargo has been in transit
* @param source the station the cargo was initially loaded
* @param source_xy the station location the cargo was initially loaded
* @param loaded_at_xy the location the cargo was loaded last
* @param feeder_share feeder share the packet has already accumulated
* @param source_type the 'type' of source the packet comes from (for subsidies)
* @param source_id the actual source of the packet (for subsidies)
*/
CargoPacket(uint16 count, byte days_in_transit, StationID source, TileIndex source_xy, TileIndex loaded_at_xy, Money feeder_share = 0, SourceType source_type = ST_INDUSTRY, SourceID source_id = INVALID_SOURCE);
/** Destroy the packet */
~CargoPacket() { }
/**
* Gets the number of 'items' in this packet.
* @return the item count
*/
FORCEINLINE uint16 Count() const
{
return this->count;
}
/**
* Gets the amount of money already paid to earlier vehicles in
* the feeder chain.
* @return the feeder share
*/
FORCEINLINE Money FeederShare() const
{
return this->feeder_share;
}
/**
* Gets the number of days this cargo has been in transit.
* This number isn't really in days, but in 2.5 days (185 ticks) and
* it is capped at 255.
* @return the length this cargo has been in transit
*/
FORCEINLINE byte DaysInTransit() const
{
return this->days_in_transit;
}
/**
* Gets the type of the cargo's source. industry, town or head quarter
* @return the source type
*/
FORCEINLINE SourceType SourceSubsidyType() const
{
return this->source_type;
}
/**
* Gets the ID of the cargo's source. An IndustryID, TownID or CompanyID
* @return the source ID
*/
FORCEINLINE SourceID SourceSubsidyID() const
{
return this->source_id;
}
/**
* Gets the ID of the station where the cargo was loaded for the first time
* @return the StationID
*/
FORCEINLINE SourceID SourceStation() const
{
return this->source;
}
/**
* Gets the coordinates of the cargo's source station
* @return the source station's coordinates
*/
FORCEINLINE TileIndex SourceStationXY() const
{
return this->source_xy;
}
/**
* Gets the coordinates of the cargo's last loading station
* @return the last loading station's coordinates
*/
FORCEINLINE TileIndex LoadedAtXY() const
{
return this->loaded_at_xy;
}
static void InvalidateAllFrom(SourceType src_type, SourceID src);
static void InvalidateAllFrom(StationID sid);
static void AfterLoad();
};
/**
* Iterate over all _valid_ cargo packets from the given start
* @param var the variable used as "iterator"
* @param start the cargo packet ID of the first packet to iterate over
*/
#define FOR_ALL_CARGOPACKETS_FROM(var, start) FOR_ALL_ITEMS_FROM(CargoPacket, cargopacket_index, var, start)
/**
* Iterate over all _valid_ cargo packets from the begin of the pool
* @param var the variable used as "iterator"
*/
#define FOR_ALL_CARGOPACKETS(var) FOR_ALL_CARGOPACKETS_FROM(var, 0)
/**
* Simple collection class for a list of cargo packets
* @tparam Tinst The actual instantation of this cargo list
*/
template <class Tinst>
class CargoList {
public:
/** Container with cargo packets */
typedef std::list<CargoPacket *> List;
/** The iterator for our container */
typedef List::iterator Iterator;
/** The const iterator for our container */
typedef List::const_iterator ConstIterator;
/** Kind of actions that could be done with packets on move */
enum MoveToAction {
MTA_FINAL_DELIVERY, ///< "Deliver" the packet to the final destination, i.e. destroy the packet
MTA_CARGO_LOAD, ///< Load the packet onto a vehicle, i.e. set the last loaded station ID
MTA_TRANSFER, ///< The cargo is moved as part of a transfer
MTA_UNLOAD, ///< The cargo is moved as part of a forced unload
};
protected:
uint count; ///< Cache for the number of cargo entities
uint cargo_days_in_transit; ///< Cache for the sum of number of days in transit of each entity; comparable to man-hours
List packets; ///< The cargo packets in this list
/**
* Update the cache to reflect adding of this packet.
* Increases count and days_in_transit
* @param cp a new packet to be inserted
*/
void AddToCache(const CargoPacket *cp);
/**
* Update the cached values to reflect the removal of this packet.
* Decreases count and days_in_transit
* @param cp Packet to be removed from cache
*/
void RemoveFromCache(const CargoPacket *cp);
public:
/** Create the cargo list */
CargoList() {}
/** And destroy it ("frees" all cargo packets) */
~CargoList();
/**
* Returns a pointer to the cargo packet list (so you can iterate over it etc).
* @return pointer to the packet list
*/
FORCEINLINE const List *Packets() const
{
return &this->packets;
}
/**
* Checks whether this list is empty
* @return true if and only if the list is empty
*/
FORCEINLINE bool Empty() const
{
return this->count == 0;
}
/**
* Returns the number of cargo entities in this list
* @return the before mentioned number
*/
FORCEINLINE uint Count() const
{
return this->count;
}
/**
* Returns source of the first cargo packet in this list
* @return the before mentioned source
*/
FORCEINLINE StationID Source() const
{
return this->Empty() ? INVALID_STATION : this->packets.front()->source;
}
/**
* Returns average number of days in transit for a cargo entity
* @return the before mentioned number
*/
FORCEINLINE uint DaysInTransit() const
{
return this->count == 0 ? 0 : this->cargo_days_in_transit / this->count;
}
/**
* Appends the given cargo packet
* @warning After appending this packet may not exist anymore!
* @note Do not use the cargo packet anymore after it has been appended to this CargoList!
* @param cp the cargo packet to add
* @pre cp != NULL
*/
void Append(CargoPacket *cp);
/**
* Truncates the cargo in this list to the given amount. It leaves the
* first count cargo entities and removes the rest.
* @param max_remaining the maximum amount of entities to be in the list after the command
*/
void Truncate(uint max_remaining);
/**
* Moves the given amount of cargo to another list.
* Depending on the value of mta the side effects of this function differ:
* - MTA_FINAL_DELIVERY: destroys the packets that do not originate from a specific station
* - MTA_CARGO_LOAD: sets the loaded_at_xy value of the moved packets
* - MTA_TRANSFER: just move without side effects
* - MTA_UNLOAD: just move without side effects
* @param dest the destination to move the cargo to
* @param count the amount of cargo entities to move
* @param mta how to handle the moving (side effects)
* @param data Depending on mta the data of this variable differs:
* - MTA_FINAL_DELIVERY - station ID of packet's origin not to remove
* - MTA_CARGO_LOAD - station's tile index of load
* - MTA_TRANSFER - unused
* - MTA_UNLOAD - unused
* @param payment The payment helper
*
* @pre mta == MTA_FINAL_DELIVERY || dest != NULL
* @pre mta == MTA_UNLOAD || mta == MTA_CARGO_LOAD || payment != NULL
* @return true if there are still packets that might be moved from this cargo list
*/
template <class Tother_inst>
bool MoveTo(Tother_inst *dest, uint count, MoveToAction mta, CargoPayment *payment, uint data = 0);
/** Invalidates the cached data and rebuild it */
void InvalidateCache();
};
/**
* CargoList that is used for vehicles.
*/
class VehicleCargoList : public CargoList<VehicleCargoList> {
protected:
/** The (direct) parent of this class */
typedef CargoList<VehicleCargoList> Parent;
Money feeder_share; ///< Cache for the feeder share
/**
* Update the cache to reflect adding of this packet.
* Increases count, feeder share and days_in_transit
* @param cp a new packet to be inserted
*/
void AddToCache(const CargoPacket *cp);
/**
* Update the cached values to reflect the removal of this packet.
* Decreases count, feeder share and days_in_transit
* @param cp Packet to be removed from cache
*/
void RemoveFromCache(const CargoPacket *cp);
public:
/** The super class ought to know what it's doing */
friend class CargoList<VehicleCargoList>;
/** The vehicles have a cargo list (and we want that saved). */
friend const struct SaveLoad *GetVehicleDescription(VehicleType vt);
/**
* Returns total sum of the feeder share for all packets
* @return the before mentioned number
*/
FORCEINLINE Money FeederShare() const
{
return this->feeder_share;
}
/**
* Ages the all cargo in this list
*/
void AgeCargo();
/** Invalidates the cached data and rebuild it */
void InvalidateCache();
/**
* Are two the two CargoPackets mergeable in the context of
* a list of CargoPackets for a Vehicle?
* @param cp1 the first CargoPacket
* @param cp2 the second CargoPacket
* @return true if they are mergeable
*/
static bool AreMergable(const CargoPacket *cp1, const CargoPacket *cp2)
{
return cp1->source_xy == cp2->source_xy &&
cp1->days_in_transit == cp2->days_in_transit &&
cp1->source_type == cp2->source_type &&
cp1->source_id == cp2->source_id &&
cp1->loaded_at_xy == cp2->loaded_at_xy;
}
};
/**
* CargoList that is used for stations.
*/
class StationCargoList : public CargoList<StationCargoList> {
public:
/** The super class ought to know what it's doing */
friend class CargoList<StationCargoList>;
/** The stations, via GoodsEntry, have a CargoList. */
friend const struct SaveLoad *GetGoodsDesc();
/**
* Are two the two CargoPackets mergeable in the context of
* a list of CargoPackets for a Vehicle?
* @param cp1 the first CargoPacket
* @param cp2 the second CargoPacket
* @return true if they are mergeable
*/
static bool AreMergable(const CargoPacket *cp1, const CargoPacket *cp2)
{
return cp1->source_xy == cp2->source_xy &&
cp1->days_in_transit == cp2->days_in_transit &&
cp1->source_type == cp2->source_type &&
cp1->source_id == cp2->source_id;
}
};
#endif /* CARGOPACKET_H */
|