OpenTTD Source
20241108-master-g80f628063a
|
A connected component of a link graph. More...
#include <linkgraph.h>
Data Structures | |
struct | BaseEdge |
An edge in the link graph. More... | |
struct | BaseNode |
Node of the link graph. More... | |
Public Types | |
typedef std::vector< BaseNode > | NodeVector |
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_pool > | |
typedef struct Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero > | Pool |
Type of the pool this item is going to be part of. | |
Public Member Functions | |
LinkGraph () | |
Bare constructor, only for save/load. | |
LinkGraph (CargoID cargo) | |
Real constructor. More... | |
void | Init (uint size) |
Resize the component and fill it with empty nodes and edges. More... | |
void | ShiftDates (TimerGameEconomy::Date interval) |
Shift all dates by given interval. More... | |
void | Compress () |
void | Merge (LinkGraph *other) |
Merge a link graph with another one. More... | |
BaseNode & | operator[] (NodeID num) |
Get a node with the specified id. More... | |
const BaseNode & | operator[] (NodeID num) const |
Get a const reference to a node with the specified id. More... | |
NodeID | Size () const |
Get the current size of the component. More... | |
TimerGameEconomy::Date | LastCompression () const |
Get date of last compression. More... | |
CargoID | Cargo () const |
Get the cargo ID this component's link graph refers to. More... | |
uint | Monthly (uint base) const |
Scale a value to its monthly equivalent, based on last compression. More... | |
NodeID | AddNode (const Station *st) |
Add a node to the component and create empty edges associated with it. More... | |
void | RemoveNode (NodeID id) |
Remove a node from the link graph by overwriting it with the last node. More... | |
Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_pool > | |
void * | operator new (size_t size) |
Allocates space for new Titem. More... | |
void * | operator new (size_t size, size_t index) |
Allocates space for new Titem with given index. More... | |
void * | operator new (size_t, void *ptr) |
Allocates space for new Titem at given memory address. More... | |
void | operator delete (void *p) |
Marks Titem as free. More... | |
Static Public Member Functions | |
static uint | Scale (uint val, TimerGameEconomy::Date target_age, TimerGameEconomy::Date orig_age) |
Scale a value from a link graph of age orig_age for usage in one of age target_age. More... | |
Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_pool > | |
static bool | CanAllocateItem (size_t n=1) |
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More... | |
static bool | CleaningPool () |
Returns current state of pool cleaning - yes or no. More... | |
static bool | IsValidID (size_t index) |
Tests whether given index can be used to get valid (non-nullptr) Titem. More... | |
static Titem * | Get (size_t index) |
Returns Titem with given index. More... | |
static Titem * | GetIfValid (size_t index) |
Returns Titem with given index. More... | |
static size_t | GetPoolSize () |
Returns first unused index. More... | |
static size_t | GetNumItems () |
Returns number of valid items in the pool. More... | |
static void | PostDestructor ([[maybe_unused]] size_t index) |
Dummy function called after destructor of each member. More... | |
static Pool::IterateWrapper< Titem > | Iterate (size_t from=0) |
Returns an iterable ensemble of all valid Titem. More... | |
Static Public Attributes | |
static const uint | MIN_TIMEOUT_DISTANCE = 32 |
Minimum effective distance for timeout calculation. | |
static constexpr TimerGameEconomy::Date | STALE_LINK_DEPOT_TIMEOUT = 1024 |
Number of days before deleting links served only by vehicles stopped in depot. | |
static constexpr TimerGameEconomy::Date | COMPRESSION_INTERVAL = 256 |
Minimum number of days between subsequent compressions of a LG. | |
Protected Attributes | |
CargoID | cargo |
Cargo of this component's link graph. | |
TimerGameEconomy::Date | last_compression |
Last time the capacities and supplies were compressed. | |
NodeVector | nodes |
Nodes in the component. | |
Friends | |
class | SlLinkgraphNode |
class | SlLinkgraphEdge |
class | LinkGraphJob |
SaveLoadTable | GetLinkGraphDesc () |
Get a SaveLoad array for a link graph. More... | |
SaveLoadTable | GetLinkGraphJobDesc () |
Get a SaveLoad array for a link graph job. More... | |
Additional Inherited Members | |
Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_pool > | |
Tindex | index |
Index of this pool item. | |
A connected component of a link graph.
Contains a complete set of stations connected by links as nodes and edges. Each component also holds a copy of the link graph settings at the time of its creation. The global settings might change between the creation and join time so we can't rely on them.
Definition at line 37 of file linkgraph.h.
|
inline |
Real constructor.
cargo | Cargo the link graph is about. |
Definition at line 197 of file linkgraph.h.
NodeID LinkGraph::AddNode | ( | const Station * | st | ) |
Add a node to the component and create empty edges associated with it.
Set the station's last_component to this component. Calculate the distances to all other nodes. The distances to all nodes are important as the demand calculator relies on their availability.
st | New node's station. |
Definition at line 149 of file linkgraph.cpp.
References cargo, GoodsEntry::GES_ACCEPTANCE, Station::goods, HasBit(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, nodes, Size(), GoodsEntry::status, and BaseStation::xy.
Referenced by Merge().
|
inline |
Get the cargo ID this component's link graph refers to.
Definition at line 242 of file linkgraph.h.
References cargo.
Referenced by LinkGraphJob::Cargo().
void LinkGraph::Init | ( | uint | size | ) |
Resize the component and fill it with empty nodes and edges.
Used when loading from save games. The component is expected to be empty before.
size | New size of the component. |
Definition at line 251 of file linkgraph.cpp.
|
inline |
Get date of last compression.
Definition at line 236 of file linkgraph.h.
References last_compression.
Referenced by LinkGraphJob::LastCompression().
void LinkGraph::Merge | ( | LinkGraph * | other | ) |
Merge a link graph with another one.
other | LinkGraph to be merged into this one. |
Definition at line 90 of file linkgraph.cpp.
References AddNode(), LinkGraph::BaseEdge::capacity, cargo, TimerGameEconomy::date, SpecializedStation< Station, false >::Get(), Station::goods, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_pool >::index, last_compression, GoodsEntry::link_graph, GoodsEntry::node, nodes, Scale(), Size(), LinkGraph::BaseEdge::travel_time_sum, and LinkGraph::BaseEdge::usage.
|
inline |
Scale a value to its monthly equivalent, based on last compression.
base | Value to be scaled. |
Definition at line 249 of file linkgraph.h.
References TimerGameEconomy::date, and last_compression.
Referenced by StationViewWindow::DrawCargoRatings().
|
inline |
Get a node with the specified id.
num | ID of the node. |
Definition at line 217 of file linkgraph.h.
References nodes.
|
inline |
Get a const reference to a node with the specified id.
num | ID of the node. |
Definition at line 224 of file linkgraph.h.
References nodes.
void LinkGraph::RemoveNode | ( | NodeID | id | ) |
Remove a node from the link graph by overwriting it with the last node.
id | ID of the node to be removed. |
Definition at line 116 of file linkgraph.cpp.
References cargo, SpecializedStation< Station, false >::Get(), Station::goods, GoodsEntry::node, nodes, and Size().
|
inlinestatic |
Scale a value from a link graph of age orig_age for usage in one of age target_age.
Make sure that the value stays > 0 if it was > 0 before.
val | Value to be scaled. |
target_age | Age of the target link graph. |
orig_age | Age of the original link graph. |
Definition at line 186 of file linkgraph.h.
Referenced by Merge().
void LinkGraph::ShiftDates | ( | TimerGameEconomy::Date | interval | ) |
Shift all dates by given interval.
This is useful if the date has been modified with the cheat menu.
interval | Number of days to be added or subtracted. |
Definition at line 53 of file linkgraph.cpp.
References TimerGameConst< struct Economy >::INVALID_DATE, last_compression, LinkGraph::BaseNode::last_update, nodes, and Size().
|
inline |
Get the current size of the component.
Definition at line 230 of file linkgraph.h.
References nodes.
Referenced by AddNode(), AfterLoadLinkGraphs(), Init(), Merge(), RemoveNode(), ShiftDates(), LinkGraphJob::Size(), and LinkGraphSchedule::SpawnNext().
|
friend |
Get a SaveLoad array for a link graph.
Definition at line 136 of file linkgraph_sl.cpp.
|
friend |
Get a SaveLoad array for a link graph job.
The settings struct is derived from the global settings saveload array. The exact entries are calculated when the function is called the first time. It's necessary to keep a copy of the settings for each link graph job so that you can change the settings while in-game and still not mess with current link graph runs. Of course the settings have to be saved and loaded, too, to avoid desyncs.
Definition at line 180 of file linkgraph_sl.cpp.