OpenTTD Source 20241224-master-gf74b0cf984
|
Simple collection class for a list of cargo packets. More...
#include <cargopacket.h>
Public Types | |
enum | MoveToAction { MTA_BEGIN = 0 , MTA_TRANSFER = 0 , MTA_DELIVER , MTA_KEEP , MTA_LOAD , MTA_END , NUM_MOVE_TO_ACTION = MTA_END } |
Kind of actions that could be done with packets on move. More... | |
typedef Tcont::iterator | Iterator |
The iterator for our container. | |
typedef Tcont::reverse_iterator | ReverseIterator |
The reverse iterator for our container. | |
typedef Tcont::const_iterator | ConstIterator |
The const iterator for our container. | |
typedef Tcont::const_reverse_iterator | ConstReverseIterator |
The const reverse iterator for our container. | |
Public Member Functions | |
CargoList () | |
Create the cargo list. | |
~CargoList () | |
Destroy the cargolist ("frees" all cargo packets). | |
void | OnCleanPool () |
Empty the cargo list, but don't free the cargo packets; the cargo packets are cleaned by CargoPacket's CleanPool. | |
const Tcont * | Packets () const |
Returns a pointer to the cargo packet list (so you can iterate over it etc). | |
uint | PeriodsInTransit () const |
Returns average number of cargo aging periods in transit for a cargo entity. | |
void | InvalidateCache () |
Invalidates the cached data and rebuilds it. | |
Protected Member Functions | |
void | AddToCache (const CargoPacket *cp) |
Update the cache to reflect adding of this packet. | |
void | RemoveFromCache (const CargoPacket *cp, uint count) |
Update the cached values to reflect the removal of this packet or part of it. | |
Static Protected Member Functions | |
static bool | TryMerge (CargoPacket *cp, CargoPacket *icp) |
Tries to merge the second packet into the first and return if that was successful. | |
Protected Attributes | |
uint | count |
Cache for the number of cargo entities. | |
uint64_t | cargo_periods_in_transit |
Cache for the sum of number of cargo aging periods in transit of each entity; comparable to man-hours. | |
Tcont | packets |
The cargo packets in this list. | |
Simple collection class for a list of cargo packets.
Tinst | Actual instantiation of this cargo list. |
Definition at line 283 of file cargopacket.h.
typedef Tcont::const_iterator CargoList< Tinst, Tcont >::ConstIterator |
The const iterator for our container.
Definition at line 290 of file cargopacket.h.
typedef Tcont::const_reverse_iterator CargoList< Tinst, Tcont >::ConstReverseIterator |
The const reverse iterator for our container.
Definition at line 292 of file cargopacket.h.
typedef Tcont::iterator CargoList< Tinst, Tcont >::Iterator |
The iterator for our container.
Definition at line 286 of file cargopacket.h.
typedef Tcont::reverse_iterator CargoList< Tinst, Tcont >::ReverseIterator |
The reverse iterator for our container.
Definition at line 288 of file cargopacket.h.
enum CargoList::MoveToAction |
Kind of actions that could be done with packets on move.
Enumerator | |
---|---|
MTA_TRANSFER | Transfer the cargo to the station. |
MTA_DELIVER | Deliver the cargo to some town or industry. |
MTA_KEEP | Keep the cargo in the vehicle. |
MTA_LOAD | Load the cargo from the station. |
Definition at line 295 of file cargopacket.h.
|
inline |
Create the cargo list.
Definition at line 319 of file cargopacket.h.
Destroy the cargolist ("frees" all cargo packets).
Definition at line 165 of file cargopacket.cpp.
|
protected |
Update the cache to reflect adding of this packet.
Increases count and periods_in_transit.
cp | New packet to be inserted. |
Definition at line 202 of file cargopacket.cpp.
References CargoPacket::count, and CargoPacket::periods_in_transit.
void CargoList< Tinst, Tcont >::InvalidateCache | ( | ) |
Invalidates the cached data and rebuilds it.
Definition at line 210 of file cargopacket.cpp.
void CargoList< Tinst, Tcont >::OnCleanPool | ( | ) |
Empty the cargo list, but don't free the cargo packets; the cargo packets are cleaned by CargoPacket's CleanPool.
Definition at line 177 of file cargopacket.cpp.
Referenced by Vehicle::~Vehicle().
|
inline |
Returns a pointer to the cargo packet list (so you can iterate over it etc).
Definition at line 329 of file cargopacket.h.
References CargoList< Tinst, Tcont >::packets.
Referenced by StationViewWindow::BuildCargoList(), and SwapPackets().
|
inline |
Returns average number of cargo aging periods in transit for a cargo entity.
Definition at line 338 of file cargopacket.h.
References CargoList< Tinst, Tcont >::count.
|
protected |
Update the cached values to reflect the removal of this packet or part of it.
Decreases count and periods_in_transit.
cp | Packet to be removed from cache. |
count | Amount of cargo from the given packet to be removed. |
Definition at line 189 of file cargopacket.cpp.
References CargoPacket::periods_in_transit.
Referenced by CargoLoad::operator()(), and CargoReservation::operator()().
|
staticprotected |
Tries to merge the second packet into the first and return if that was successful.
Definition at line 228 of file cargopacket.cpp.
References CargoPacket::count, CargoPacket::MAX_COUNT, and CargoPacket::Merge().
|
protected |
Cache for the sum of number of cargo aging periods in transit of each entity; comparable to man-hours.
Definition at line 307 of file cargopacket.h.
|
protected |
Cache for the number of cargo entities.
Definition at line 306 of file cargopacket.h.
Referenced by CargoList< Tinst, Tcont >::PeriodsInTransit().
|
protected |
The cargo packets in this list.
Definition at line 309 of file cargopacket.h.
Referenced by CargoList< Tinst, Tcont >::Packets().