OpenTTD Source
20241121-master-g67a0fccfad
|
Flow statistics telling how much flow should be sent along a link. More...
#include <station_base.h>
Public Types | |
typedef std::map< uint32_t, StationID > | SharesMap |
Public Member Functions | |
FlowStat () | |
Invalid constructor. More... | |
FlowStat (StationID st, uint flow, bool restricted=false) | |
Create a FlowStat with an initial entry. More... | |
void | AppendShare (StationID st, uint flow, bool restricted=false) |
Add some flow to the end of the shares map. More... | |
uint | GetShare (StationID st) const |
Get flow for a station. More... | |
void | ChangeShare (StationID st, int flow) |
Change share for specified station. More... | |
void | RestrictShare (StationID st) |
Restrict a flow by moving it to the end of the map and decreasing the amount of unrestricted flow. More... | |
void | ReleaseShare (StationID st) |
Release ("unrestrict") a flow by moving it to the begin of the map and increasing the amount of unrestricted flow. More... | |
void | ScaleToMonthly (uint runtime) |
Scale all shares from link graph's runtime to monthly values. More... | |
const SharesMap * | GetShares () const |
Get the actual shares as a const pointer so that they can be iterated over. More... | |
uint | GetUnrestricted () const |
Return total amount of unrestricted shares. More... | |
void | SwapShares (FlowStat &other) |
Swap the shares maps, and thus the content of this FlowStat with the other one. More... | |
StationID | GetViaWithRestricted (bool &is_restricted) const |
Get a station a package can be routed to. More... | |
StationID | GetVia () const |
Get a station a package can be routed to. More... | |
StationID | GetVia (StationID excluded, StationID excluded2=INVALID_STATION) const |
Get a station a package can be routed to, but exclude the given ones. More... | |
void | Invalidate () |
Reduce all flows to minimum capacity so that they don't get in the way of link usage statistics too much. More... | |
Static Public Attributes | |
static const SharesMap | empty_sharesmap |
Static instance of FlowStat::SharesMap. More... | |
Private Attributes | |
SharesMap | shares |
Shares of flow to be sent via specified station (or consumed locally). | |
uint | unrestricted |
Limit for unrestricted shares. | |
Flow statistics telling how much flow should be sent along a link.
This is done by creating "flow shares" and using std::map's upper_bound() method to look them up with a random number. A flow share is the difference between a key in a map and the previous key. So one key in the map doesn't actually mean anything by itself.
Definition at line 32 of file station_base.h.
|
inline |
Invalid constructor.
This can't be called as a FlowStat must not be empty. However, the constructor must be defined and reachable for FlowStat to be used in a std::map.
Definition at line 43 of file station_base.h.
|
inline |
Create a FlowStat with an initial entry.
st | Station the initial entry refers to. |
flow | Amount of flow for the initial entry. |
restricted | If the flow to be added is restricted. |
Definition at line 51 of file station_base.h.
References shares, and unrestricted.
|
inline |
Add some flow to the end of the shares map.
Only do that if you know that the station isn't in the map yet. Anything else may lead to inconsistencies.
st | Remote station. |
flow | Amount of flow to be added. |
restricted | If the flow to be added is restricted. |
Definition at line 66 of file station_base.h.
References shares, and unrestricted.
Referenced by FlowStatMap::PassOnFlow().
void FlowStat::ChangeShare | ( | StationID | st, |
int | flow | ||
) |
Change share for specified station.
By specifying INT_MIN as parameter you can erase a share. Newly added flows will be unrestricted.
st | Next Hop to be removed. |
flow | Share to be added or removed. |
Definition at line 4874 of file station_cmd.cpp.
References shares, and unrestricted.
Referenced by FlowStatMap::DeleteFlows().
uint FlowStat::GetShare | ( | StationID | st | ) | const |
Get flow for a station.
st | Station to get flow for. |
Definition at line 4783 of file station_cmd.cpp.
References shares.
Referenced by FlowStatMap::FinalizeLocalConsumption().
|
inline |
Get the actual shares as a const pointer so that they can be iterated over.
Definition at line 88 of file station_base.h.
References shares.
Referenced by FlowStatMap::DeleteFlows().
|
inline |
Return total amount of unrestricted shares.
Definition at line 94 of file station_base.h.
References unrestricted.
|
inline |
Get a station a package can be routed to.
This done by drawing a random number between 0 and sum_shares and then looking that up in the map with lower_bound. So each share gets selected with a probability dependent on its flow. Don't include restricted flows.
Definition at line 130 of file station_base.h.
References RandomRange(), shares, and unrestricted.
Get a station a package can be routed to, but exclude the given ones.
excluded | StationID not to be selected. |
excluded2 | Another StationID not to be selected. |
Definition at line 4802 of file station_cmd.cpp.
References unrestricted.
|
inline |
Get a station a package can be routed to.
This done by drawing a random number between 0 and sum_shares and then looking that up in the map with lower_bound. So each share gets selected with a probability dependent on its flow. Do include restricted flows here.
is_restricted | Output if a restricted flow was chosen. |
Definition at line 115 of file station_base.h.
References RandomRange(), shares, and unrestricted.
void FlowStat::Invalidate | ( | ) |
Reduce all flows to minimum capacity so that they don't get in the way of link usage statistics too much.
Keep them around, though, to continue routing any remaining cargo.
Definition at line 4855 of file station_cmd.cpp.
References shares, and unrestricted.
void FlowStat::ReleaseShare | ( | StationID | st | ) |
Release ("unrestrict") a flow by moving it to the begin of the map and increasing the amount of unrestricted flow.
st | Station of flow to be released. |
Definition at line 4955 of file station_cmd.cpp.
References shares, and unrestricted.
void FlowStat::RestrictShare | ( | StationID | st | ) |
Restrict a flow by moving it to the end of the map and decreasing the amount of unrestricted flow.
st | Station of flow to be restricted. |
Definition at line 4924 of file station_cmd.cpp.
References shares, and unrestricted.
void FlowStat::ScaleToMonthly | ( | uint | runtime | ) |
Scale all shares from link graph's runtime to monthly values.
runtime | Time the link graph has been running without compression. |
Definition at line 4992 of file station_cmd.cpp.
References shares, and unrestricted.
|
inline |
Swap the shares maps, and thus the content of this FlowStat with the other one.
other | FlowStat to swap with. |
Definition at line 101 of file station_base.h.
References shares, Swap(), and unrestricted.
|
static |
Static instance of FlowStat::SharesMap.
Note: This instance is created on task start. Lazy creation on first usage results in a data race between the CDist threads.
Definition at line 36 of file station_base.h.
Referenced by FlowEdgeIterator::SetNode().