OpenTTD Source
20241108-master-g80f628063a
|
Class for calculation jobs to be run on link graphs. More...
#include <linkgraphjob.h>
Data Structures | |
struct | DemandAnnotation |
Demand between two nodes. More... | |
struct | EdgeAnnotation |
Annotation for a link graph edge. More... | |
struct | NodeAnnotation |
Annotation for a link graph node. More... | |
Public Member Functions | |
LinkGraphJob () | |
Bare constructor, only for save/load. More... | |
LinkGraphJob (const LinkGraph &orig) | |
Create a link graph job from a link graph. More... | |
~LinkGraphJob () | |
Join the link graph job and destroy it. | |
void | Init () |
Initialize the link graph job: Resize nodes and edges and populate them. More... | |
bool | IsJobCompleted () const |
Check if job has actually finished. More... | |
bool | IsJobAborted () const |
Check if job has been aborted. More... | |
void | AbortJob () |
Abort job. More... | |
bool | IsScheduledToBeJoined () const |
Check if job is supposed to be finished. More... | |
TimerGameEconomy::Date | JoinDate () const |
Get the date when the job should be finished. More... | |
void | ShiftJoinDate (TimerGameEconomy::Date interval) |
Change the join date on date cheating. More... | |
const LinkGraphSettings & | Settings () const |
Get the link graph settings for this component. More... | |
NodeAnnotation & | operator[] (NodeID num) |
Get a node abstraction with the specified id. More... | |
NodeID | Size () const |
Get the size of the underlying link graph. More... | |
CargoID | Cargo () const |
Get the cargo of the underlying link graph. More... | |
TimerGameEconomy::Date | LastCompression () const |
Get the date when the underlying link graph was last compressed. More... | |
LinkGraphID | LinkGraphIndex () const |
Get the ID of the underlying link graph. More... | |
const LinkGraph & | Graph () const |
Get a reference to the underlying link graph. More... | |
Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_job_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... | |
Protected Member Functions | |
void | EraseFlows (NodeID from) |
Erase all flows originating at a specific node. More... | |
void | JoinThread () |
Join the calling thread with this job's thread if threading is enabled. | |
void | SpawnThread () |
Spawn a thread if possible and run the link graph job in the thread. More... | |
Protected Attributes | |
const LinkGraph | link_graph |
Link graph to by analyzed. Is copied when job is started and mustn't be modified later. | |
const LinkGraphSettings | settings |
Copy of _settings_game.linkgraph at spawn time. | |
std::thread | thread |
Thread the job is running in or a default-constructed thread if it's running in the main thread. | |
TimerGameEconomy::Date | join_date |
Date when the job is to be joined. | |
NodeAnnotationVector | nodes |
Extra node data necessary for link graph calculation. | |
std::atomic< bool > | job_completed |
Is the job still running. This is accessed by multiple threads and reads may be stale. | |
std::atomic< bool > | job_aborted |
Has the job been aborted. This is accessed by multiple threads and reads may be stale. | |
Private Types | |
typedef std::vector< NodeAnnotation > | NodeAnnotationVector |
Friends | |
class | LinkGraphSchedule |
SaveLoadTable | GetLinkGraphJobDesc () |
Get a SaveLoad array for a link graph job. More... | |
Additional Inherited Members | |
Public Types inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_job_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. | |
Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_job_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... | |
Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_link_graph_job_pool > | |
Tindex | index |
Index of this pool item. | |
Class for calculation jobs to be run on link graphs.
Definition at line 29 of file linkgraphjob.h.
|
inline |
Bare constructor, only for save/load.
link_graph, join_date and actually settings have to be brutally const-casted in order to populate them.
Definition at line 180 of file linkgraphjob.h.
LinkGraphJob::LinkGraphJob | ( | const LinkGraph & | orig | ) |
Create a link graph job from a link graph.
The link graph will be copied so that the calculations don't interfer with the normal operations on the original. The job is immediately started.
orig | Original LinkGraph to be copied. |
Definition at line 35 of file linkgraphjob.cpp.
|
inline |
Abort job.
The job may exit early at the next available opportunity. After this method has been called the state of the job is undefined, and the only valid operation is to join the thread and discard the job data.
Definition at line 208 of file linkgraphjob.h.
|
inline |
Get the cargo of the underlying link graph.
Definition at line 251 of file linkgraphjob.h.
References LinkGraph::Cargo().
Referenced by DemandCalculator::DemandCalculator().
|
protected |
Erase all flows originating at a specific node.
from | Node to erase flows for. |
Definition at line 50 of file linkgraphjob.cpp.
References Size().
|
inline |
Get a reference to the underlying link graph.
Only use this for save/load.
Definition at line 269 of file linkgraphjob.h.
References link_graph.
Referenced by AfterLoadLinkGraphs().
void LinkGraphJob::Init | ( | ) |
Initialize the link graph job: Resize nodes and edges and populate them.
This is done after the constructor so that we can do it in the calculation thread without delaying the main game.
Definition at line 182 of file linkgraphjob.cpp.
References link_graph, LinkGraph::nodes, nodes, and Size().
Referenced by InitHandler::Run().
|
inline |
Check if job has been aborted.
This is allowed to spuriously return false incorrectly, but is not allowed to incorrectly return true.
Definition at line 200 of file linkgraphjob.h.
Referenced by LinkGraphSchedule::Run(), and ~LinkGraphJob().
|
inline |
Check if job has actually finished.
This is allowed to spuriously return an incorrect value.
Definition at line 193 of file linkgraphjob.h.
Referenced by LinkGraphSchedule::IsJoinWithUnfinishedJobDue().
|
inline |
Check if job is supposed to be finished.
Definition at line 214 of file linkgraphjob.h.
References TimerGameEconomy::date.
Referenced by LinkGraphSchedule::IsJoinWithUnfinishedJobDue(), and LinkGraphSchedule::JoinNext().
|
inline |
Get the date when the job should be finished.
Definition at line 220 of file linkgraphjob.h.
References join_date.
Referenced by FlowMapper::Run().
|
inline |
Get the date when the underlying link graph was last compressed.
Definition at line 257 of file linkgraphjob.h.
References LinkGraph::LastCompression().
Referenced by FlowMapper::Run().
|
inline |
Get the ID of the underlying link graph.
Definition at line 263 of file linkgraphjob.h.
References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index.
Referenced by LinkGraphSchedule::JoinNext().
|
inline |
Get a node abstraction with the specified id.
num | ID of the node. |
Definition at line 239 of file linkgraphjob.h.
|
inline |
Get the link graph settings for this component.
Definition at line 232 of file linkgraphjob.h.
References settings.
Referenced by DemandCalculator::DemandCalculator(), and FlowMapper::Run().
|
inline |
Change the join date on date cheating.
interval | Number of days to add. |
Definition at line 226 of file linkgraphjob.h.
|
inline |
Get the size of the underlying link graph.
Definition at line 245 of file linkgraphjob.h.
References LinkGraph::Size().
Referenced by DemandCalculator::CalcDemand(), EraseFlows(), FlowEdgeIterator::FlowEdgeIterator(), Init(), and FlowMapper::Run().
|
protected |
Spawn a thread if possible and run the link graph job in the thread.
If that's not possible run the job right now in the current thread.
Definition at line 61 of file linkgraphjob.cpp.
References LinkGraphSchedule::Run(), StartNewThread(), and thread.
Referenced by LinkGraphSchedule::SpawnNext().
|
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.