OpenTTD Source 20250205-master-gfd85ab1e2c
|
Stores station stats for a single cargo. More...
#include <station_base.h>
Data Structures | |
struct | GoodsEntryData |
Public Types | |
enum | GoodsEntryStatus : uint8_t { GES_ACCEPTANCE , GES_RATING , GES_EVER_ACCEPTED , GES_LAST_MONTH , GES_CURRENT_MONTH , GES_ACCEPTED_BIGTICK } |
Status of this cargo for the station. More... | |
Public Member Functions | |
bool | HasVehicleEverTriedLoading () const |
Reports whether a vehicle has ever tried to load the cargo at this station. | |
bool | HasRating () const |
Does this cargo have a rating at this station? | |
StationID | GetVia (StationID source) const |
Get the best next hop for a cargo packet from station source. | |
StationID | GetVia (StationID source, StationID excluded, StationID excluded2=INVALID_STATION) const |
Get the best next hop for a cargo packet from station source, optionally excluding one or two stations. | |
debug_inline bool | HasData () const |
Test if this goods entry has optional cargo packet/flow data. | |
void | ClearData () |
Clear optional cargo packet/flow data. | |
debug_inline const GoodsEntryData & | GetData () const |
Get optional cargo packet/flow data. | |
debug_inline GoodsEntryData & | GetData () |
Get non-const optional cargo packet/flow data. | |
GoodsEntryData & | GetOrCreateData () |
Get optional cargo packet/flow data. | |
Data Fields | |
uint | max_waiting_cargo = 0 |
Max cargo from this station waiting at any station. | |
NodeID | node = INVALID_NODE |
ID of node in link graph referring to this goods entry. | |
LinkGraphID | link_graph = INVALID_LINK_GRAPH |
Link graph this station belongs to. | |
uint8_t | status = 0 |
Status of this cargo, see GoodsEntryStatus. | |
uint8_t | time_since_pickup = 255 |
Number of rating-intervals (up to 255) since the last vehicle tried to load this cargo. | |
uint8_t | rating = INITIAL_STATION_RATING |
Station rating for this cargo. | |
uint8_t | last_speed = 0 |
Maximum speed (up to 255) of the last vehicle that tried to load this cargo. | |
uint8_t | last_age = 255 |
Age in years (up to 255) of the last vehicle that tried to load this cargo. | |
uint8_t | amount_fract = 0 |
Fractional part of the amount in the cargo list. | |
Private Attributes | |
std::unique_ptr< GoodsEntryData > | data = nullptr |
Optional cargo packet and flow data. | |
Stores station stats for a single cargo.
Definition at line 166 of file station_base.h.
enum GoodsEntry::GoodsEntryStatus : uint8_t |
Status of this cargo for the station.
Definition at line 168 of file station_base.h.
|
inline |
Clear optional cargo packet/flow data.
Definition at line 308 of file station_base.h.
References data.
Referenced by LinkGraphJob::~LinkGraphJob().
|
inline |
Get non-const optional cargo packet/flow data.
Definition at line 326 of file station_base.h.
|
inline |
Get optional cargo packet/flow data.
Definition at line 315 of file station_base.h.
References data, and HasData().
Referenced by LinkGraphOverlay::AddLinks(), StationViewWindow::BuildCargoList(), DeleteStaleLinks(), StationViewWindow::DrawEntries(), CompanyStationsWindow::DrawWidget(), StationViewWindow::EstimateDestinations(), GetVia(), GetVia(), HandleStationRefit(), LoadUnloadVehicle(), StationViewWindow::RecalcDestinations(), RerouteCargo(), StationResolverObject::ResolveReal(), VehicleCargoList::Stage(), StationResolverObject::StationResolverObject(), CompanyStationsWindow::StationWaitingAvailableSorter(), CompanyStationsWindow::StationWaitingTotalSorter(), TruncateCargo(), LinkGraphJob::~LinkGraphJob(), and Station::~Station().
|
inline |
Get optional cargo packet/flow data.
The data is create if it is not already present.
Definition at line 336 of file station_base.h.
References data, and HasData().
Referenced by Vehicle::CancelReservation(), LoadUnloadVehicle(), ReturnCargoAction::operator()(), FinalizeRefitAction::operator()(), SwapPackets(), and LinkGraphJob::~LinkGraphJob().
|
inline |
Get the best next hop for a cargo packet from station source.
source | Source of the packet. |
Definition at line 275 of file station_base.h.
References GoodsEntry::GoodsEntryData::flows, GetData(), and HasData().
Referenced by StationCargoReroute::operator()(), and VehicleCargoReroute::operator()().
|
inline |
Get the best next hop for a cargo packet from station source, optionally excluding one or two stations.
source | Source of the packet. |
excluded | If this station would be chosen choose the second best one instead. |
excluded2 | Second station to be excluded, if != INVALID_STATION. |
Definition at line 291 of file station_base.h.
References GoodsEntry::GoodsEntryData::flows, GetData(), and HasData().
|
inline |
Test if this goods entry has optional cargo packet/flow data.
Definition at line 303 of file station_base.h.
References data.
Referenced by LinkGraphOverlay::AddLinks(), StationViewWindow::BuildCargoList(), DeleteStaleLinks(), StationViewWindow::DrawEntries(), CompanyStationsWindow::DrawWidget(), StationViewWindow::EstimateDestinations(), GetData(), GetData(), GetOrCreateData(), GetVia(), GetVia(), HandleStationRefit(), LoadUnloadVehicle(), StationViewWindow::RecalcDestinations(), RerouteCargo(), StationResolverObject::ResolveReal(), VehicleCargoList::Stage(), StationResolverObject::StationResolverObject(), CompanyStationsWindow::StationWaitingAvailableSorter(), CompanyStationsWindow::StationWaitingTotalSorter(), TruncateCargo(), and Station::~Station().
|
inline |
Does this cargo have a rating at this station?
Definition at line 265 of file station_base.h.
References GES_RATING, and HasBit().
Referenced by CalcPercentVehicleFilled(), StationViewWindow::DrawCargoRatings(), CompanyStationsWindow::DrawWidget(), LoadUnloadVehicle(), CompanyStationsWindow::StationRatingMaxSorter(), and CompanyStationsWindow::StationRatingMinSorter().
|
inline |
Reports whether a vehicle has ever tried to load the cargo at this station.
This does not imply that there was cargo available for loading. Refer to GES_RATING for that.
Definition at line 259 of file station_base.h.
uint8_t GoodsEntry::amount_fract = 0 |
Fractional part of the amount in the cargo list.
Definition at line 252 of file station_base.h.
|
private |
Optional cargo packet and flow data.
Definition at line 343 of file station_base.h.
Referenced by ClearData(), GetData(), GetData(), GetOrCreateData(), and HasData().
uint8_t GoodsEntry::last_age = 255 |
Age in years (up to 255) of the last vehicle that tried to load this cargo.
This does not imply there was any cargo to load.
Definition at line 250 of file station_base.h.
Referenced by LoadUnloadVehicle().
uint8_t GoodsEntry::last_speed = 0 |
Maximum speed (up to 255) of the last vehicle that tried to load this cargo.
This does not imply there was any cargo to load. The unit used is a special vehicle-specific speed unit for station ratings.
Definition at line 244 of file station_base.h.
Referenced by LoadUnloadVehicle().
LinkGraphID GoodsEntry::link_graph = INVALID_LINK_GRAPH |
Link graph this station belongs to.
Definition at line 222 of file station_base.h.
Referenced by LinkGraphOverlay::AddLinks(), DeleteStaleLinks(), StationViewWindow::DrawCargoRatings(), IncreaseStats(), LinkGraph::Merge(), LinkRefresher::RefreshStats(), UpdateStationAcceptance(), and LinkGraphJob::~LinkGraphJob().
uint GoodsEntry::max_waiting_cargo = 0 |
Max cargo from this station waiting at any station.
Definition at line 220 of file station_base.h.
Referenced by TruncateCargo().
NodeID GoodsEntry::node = INVALID_NODE |
ID of node in link graph referring to this goods entry.
Definition at line 221 of file station_base.h.
Referenced by LinkGraphOverlay::AddLinks(), DeleteStaleLinks(), StationViewWindow::DrawCargoRatings(), IncreaseStats(), LinkGraph::Merge(), LinkGraph::RemoveNode(), UpdateStationAcceptance(), and LinkGraphJob::~LinkGraphJob().
uint8_t GoodsEntry::rating = INITIAL_STATION_RATING |
Station rating for this cargo.
Definition at line 233 of file station_base.h.
Referenced by StationViewWindow::DrawCargoRatings(), CompanyStationsWindow::DrawWidget(), CompanyStationsWindow::StationRatingMaxSorter(), and CompanyStationsWindow::StationRatingMinSorter().
uint8_t GoodsEntry::status = 0 |
Status of this cargo, see GoodsEntryStatus.
Definition at line 224 of file station_base.h.
Referenced by LinkGraph::AddNode(), DeliverGoods(), LoadUnloadVehicle(), PrepareUnload(), TriggerWatchedCargoCallbacks(), and UpdateStationAcceptance().
uint8_t GoodsEntry::time_since_pickup = 255 |
Number of rating-intervals (up to 255) since the last vehicle tried to load this cargo.
The unit used is STATION_RATING_TICKS. This does not imply there was any cargo to load.
Definition at line 231 of file station_base.h.
Referenced by LoadUnloadVehicle().