OpenTTD
Typedefs | Functions | Variables
linkgraph_sl.cpp File Reference

Code handling saving and loading of link graphs. More...

#include "../stdafx.h"
#include "../linkgraph/linkgraph.h"
#include "../linkgraph/linkgraphjob.h"
#include "../linkgraph/linkgraphschedule.h"
#include "../settings_internal.h"
#include "saveload.h"
#include "../safeguards.h"

Go to the source code of this file.

Typedefs

typedef LinkGraph::BaseNode Node
 
typedef LinkGraph::BaseEdge Edge
 

Functions

const SettingDescGetSettingDescription (uint index)
 
const SaveLoadGetLinkGraphDesc ()
 Get a SaveLoad array for a link graph. More...
 
const SaveLoadGetLinkGraphJobDesc ()
 Get a SaveLoad array for a link graph job. More...
 
const SaveLoadGetLinkGraphScheduleDesc ()
 Get a SaveLoad array for the link graph schedule. More...
 
void SaveLoad_LinkGraph (LinkGraph &lg)
 Save/load a link graph. More...
 
static void DoSave_LGRJ (LinkGraphJob *lgj)
 Save a link graph job. More...
 
static void DoSave_LGRP (LinkGraph *lg)
 Save a link graph. More...
 
static void Load_LGRP ()
 Load all link graphs.
 
static void Load_LGRJ ()
 Load all link graph jobs.
 
static void Load_LGRS ()
 Load the link graph schedule.
 
void AfterLoadLinkGraphs ()
 Spawn the threads for running link graph calculations. More...
 
static void Save_LGRP ()
 Save all link graphs.
 
static void Save_LGRJ ()
 Save all link graph jobs.
 
static void Save_LGRS ()
 Save the link graph schedule.
 
static void Ptrs_LGRS ()
 Substitute pointers in link graph schedule.
 

Variables

static uint16 _num_nodes
 
static const SaveLoad _node_desc []
 SaveLoad desc for a link graph node. More...
 
static const SaveLoad _edge_desc []
 SaveLoad desc for a link graph edge. More...
 
const ChunkHandler _linkgraph_chunk_handlers []
 

Detailed Description

Code handling saving and loading of link graphs.

Definition in file linkgraph_sl.cpp.

Function Documentation

◆ AfterLoadLinkGraphs()

void AfterLoadLinkGraphs ( )

Spawn the threads for running link graph calculations.

Has to be done after loading as the cargo classes might have changed.

Definition at line 230 of file linkgraph_sl.cpp.

References IsSavegameVersionBefore().

◆ DoSave_LGRJ()

static void DoSave_LGRJ ( LinkGraphJob lgj)
static

Save a link graph job.

Parameters
lgjLinkGraphJob to be saved.

Definition at line 161 of file linkgraph_sl.cpp.

References GetLinkGraphJobDesc(), and SlObject().

◆ DoSave_LGRP()

static void DoSave_LGRP ( LinkGraph lg)
static

Save a link graph.

Parameters
lgLinkGraph to be saved.

Definition at line 173 of file linkgraph_sl.cpp.

◆ GetLinkGraphDesc()

const SaveLoad* GetLinkGraphDesc ( )

Get a SaveLoad array for a link graph.

Returns
SaveLoad array for link graph.

Definition at line 32 of file linkgraph_sl.cpp.

References SLE_VAR.

◆ GetLinkGraphJobDesc()

const SaveLoad* GetLinkGraphJobDesc ( )

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.

Returns
Array of SaveLoad structs.

Definition at line 52 of file linkgraph_sl.cpp.

References SmallVector< T, S >::Length().

Referenced by DoSave_LGRJ().

◆ GetLinkGraphScheduleDesc()

const SaveLoad* GetLinkGraphScheduleDesc ( )

Get a SaveLoad array for the link graph schedule.

Returns
SaveLoad array for the link graph schedule.

Definition at line 96 of file linkgraph_sl.cpp.

References REF_LINK_GRAPH, and SLE_LST.

Referenced by Load_LGRS(), Ptrs_LGRS(), and Save_LGRS().

◆ SaveLoad_LinkGraph()

void SaveLoad_LinkGraph ( LinkGraph lg)

Save/load a link graph.

Parameters
compLink graph to be saved or loaded.

Definition at line 137 of file linkgraph_sl.cpp.

References LinkGraph::edges, IsSavegameVersionBefore(), LinkGraph::nodes, LinkGraph::Size(), and SlObject().

Variable Documentation

◆ _edge_desc

const SaveLoad _edge_desc[]
static
Initial value:
= {
SLE_CONDNULL(4, 0, 190),
SLE_VAR(Edge, capacity, SLE_UINT32),
SLE_VAR(Edge, usage, SLE_UINT32),
SLE_VAR(Edge, last_unrestricted_update, SLE_INT32),
SLE_CONDVAR(Edge, last_restricted_update, SLE_INT32, 187, SL_MAX_VERSION),
SLE_VAR(Edge, next_edge, SLE_UINT16),
}
#define SLE_CONDNULL(length, from, to)
Empty space in some savegame versions.
Definition: saveload.h:344
#define SLE_CONDVAR(base, variable, type, from, to)
Storage of a variable in some savegame versions.
Definition: saveload.h:246
#define SL_MAX_VERSION
Highest possible savegame version.
Definition: saveload.h:96
An updatable edge class.
Definition: linkgraph.h:293
#define SLE_VAR(base, variable, type)
Storage of a variable in every version of a savegame.
Definition: saveload.h:296

SaveLoad desc for a link graph edge.

Definition at line 123 of file linkgraph_sl.cpp.

◆ _linkgraph_chunk_handlers

const ChunkHandler _linkgraph_chunk_handlers[]
Initial value:
= {
{ 'LGRP', Save_LGRP, Load_LGRP, NULL, NULL, CH_ARRAY },
{ 'LGRJ', Save_LGRJ, Load_LGRJ, NULL, NULL, CH_ARRAY },
{ 'LGRS', Save_LGRS, Load_LGRS, Ptrs_LGRS, NULL, CH_LAST }
}
static void Load_LGRJ()
Load all link graph jobs.
static void Ptrs_LGRS()
Substitute pointers in link graph schedule.
static void Load_LGRS()
Load the link graph schedule.
static void Save_LGRP()
Save all link graphs.
static void Save_LGRJ()
Save all link graph jobs.
static void Save_LGRS()
Save the link graph schedule.
static void Load_LGRP()
Load all link graphs.
Last chunk in this array.
Definition: saveload.h:104

◆ _node_desc

const SaveLoad _node_desc[]
static
Initial value:
= {
SLE_CONDVAR(Node, xy, SLE_UINT32, 191, SL_MAX_VERSION),
SLE_VAR(Node, supply, SLE_UINT32),
SLE_VAR(Node, demand, SLE_UINT32),
SLE_VAR(Node, station, SLE_UINT16),
SLE_VAR(Node, last_update, SLE_INT32),
}
#define SLE_CONDVAR(base, variable, type, from, to)
Storage of a variable in some savegame versions.
Definition: saveload.h:246
Updatable node class.
Definition: linkgraph.h:374
#define SL_MAX_VERSION
Highest possible savegame version.
Definition: saveload.h:96
#define SLE_VAR(base, variable, type)
Storage of a variable in every version of a savegame.
Definition: saveload.h:296

SaveLoad desc for a link graph node.

Definition at line 111 of file linkgraph_sl.cpp.