OpenTTD Source 20261112-master-gbcbec5e63f
LinkGraph::BaseEdge Struct Reference

An edge in the link graph. More...

#include <linkgraph.h>

Public Member Functions

 BaseEdge (NodeID dest_node=INVALID_NODE)
 Create an edge.
uint32_t TravelTime () const
 Get edge's average travel time.
TimerGameEconomy::Date LastUpdate () const
 Get the date of the last update to any part of the edge's capacity.
void Update (uint capacity, uint usage, uint32_t time, EdgeUpdateModes modes)
 Update an edge.
void Restrict ()
void Release ()
auto operator<=> (const BaseEdge &rhs) const noexcept
 Comparison operator based on dest_node.
auto operator<=> (NodeID rhs) const noexcept
 Compare with a NodeID.

Data Fields

uint capacity = 0
 Capacity of the link.
uint usage = 0
 Usage of the link.
uint64_t travel_time_sum = 0
 Sum of the travel times of the link, in ticks.
TimerGameEconomy::Date last_unrestricted_update {}
 When the unrestricted part of the link was last updated.
TimerGameEconomy::Date last_restricted_update {}
 When the restricted part of the link was last updated.
NodeID dest_node = INVALID_NODE
 Destination of the edge.

Friends

auto operator<=> (NodeID lhs, const LinkGraph::BaseEdge &rhs) noexcept
 Compare a NodeID with a BaseEdge.

Detailed Description

An edge in the link graph.

Corresponds to a link between two stations.

Definition at line 40 of file linkgraph.h.

Constructor & Destructor Documentation

◆ BaseEdge()

LinkGraph::BaseEdge::BaseEdge ( NodeID dest_node = INVALID_NODE)

Create an edge.

Parameters
dest_nodeThe destination of this edge.

Definition at line 39 of file linkgraph.cpp.

References capacity, dest_node, TimerGameConst< struct Economy >::INVALID_DATE, last_restricted_update, last_unrestricted_update, travel_time_sum, and usage.

Referenced by operator<=>().

Member Function Documentation

◆ LastUpdate()

TimerGameEconomy::Date LinkGraph::BaseEdge::LastUpdate ( ) const
inline

Get the date of the last update to any part of the edge's capacity.

Returns
Last update.

Definition at line 60 of file linkgraph.h.

◆ operator<=>() [1/2]

auto LinkGraph::BaseEdge::operator<=> ( const BaseEdge & rhs) const
inlinenoexcept

Comparison operator based on dest_node.

Parameters
rhsThe right hand side of the comparison.
Returns
true iff our dest_node is smaller than the other's.

Definition at line 71 of file linkgraph.h.

References BaseEdge(), and dest_node.

◆ operator<=>() [2/2]

auto LinkGraph::BaseEdge::operator<=> ( NodeID rhs) const
inlinenoexcept

Compare with a NodeID.

Parameters
rhsThe right hand side of the comparison.
Returns
The std::strong_ordering of the comparison.

Definition at line 81 of file linkgraph.h.

References dest_node.

◆ Release()

void LinkGraph::BaseEdge::Release ( )
inline

Definition at line 64 of file linkgraph.h.

◆ Restrict()

void LinkGraph::BaseEdge::Restrict ( )
inline

Definition at line 63 of file linkgraph.h.

◆ TravelTime()

uint32_t LinkGraph::BaseEdge::TravelTime ( ) const
inline

Get edge's average travel time.

Returns
Travel time, in ticks.

Definition at line 54 of file linkgraph.h.

Referenced by LinkGraphOverlay::AddLinks(), and MultiCommodityFlow::Dijkstra().

◆ Update()

void LinkGraph::BaseEdge::Update ( uint capacity,
uint usage,
uint32_t travel_time,
EdgeUpdateModes modes )

Update an edge.

If mode contains UM_REFRESH refresh the edge to have at least the given capacity and usage, otherwise add the capacity, usage and travel time. In any case set the respective update timestamp(s), according to the given mode.

Parameters
capacityCapacity to be added/updated.
usageUsage to be added.
travel_timeTravel time to be added, in ticks.
modesUpdate modes to be applied.

Definition at line 220 of file linkgraph.cpp.

References capacity, TimerGameEconomy::date, Increase, last_restricted_update, last_unrestricted_update, Refresh, Restricted, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), travel_time_sum, Unrestricted, and usage.

◆ operator<=>

auto operator<=> ( NodeID lhs,
const LinkGraph::BaseEdge & rhs )
friend

Compare a NodeID with a BaseEdge.

Parameters
lhsThe left hand side of the comparison.
rhsThe right hand side of the comparison.
Returns
The std::strong_ordering of the comparison.

Definition at line 92 of file linkgraph.h.

Field Documentation

◆ capacity

uint LinkGraph::BaseEdge::capacity = 0

◆ dest_node

NodeID LinkGraph::BaseEdge::dest_node = INVALID_NODE

◆ last_restricted_update

TimerGameEconomy::Date LinkGraph::BaseEdge::last_restricted_update {}

When the restricted part of the link was last updated.

Definition at line 45 of file linkgraph.h.

Referenced by LinkGraph::BaseNode::AddEdge(), BaseEdge(), and Update().

◆ last_unrestricted_update

TimerGameEconomy::Date LinkGraph::BaseEdge::last_unrestricted_update {}

When the unrestricted part of the link was last updated.

Definition at line 44 of file linkgraph.h.

Referenced by LinkGraph::BaseNode::AddEdge(), BaseEdge(), and Update().

◆ travel_time_sum

uint64_t LinkGraph::BaseEdge::travel_time_sum = 0

Sum of the travel times of the link, in ticks.

Definition at line 43 of file linkgraph.h.

Referenced by LinkGraph::BaseNode::AddEdge(), BaseEdge(), LinkGraph::Merge(), and Update().

◆ usage

uint LinkGraph::BaseEdge::usage = 0

Usage of the link.

Definition at line 42 of file linkgraph.h.

Referenced by LinkGraph::BaseNode::AddEdge(), LinkGraphOverlay::AddLinks(), BaseEdge(), LinkGraph::Merge(), and Update().


The documentation for this struct was generated from the following files: