PBSTileInfo Struct Reference

This struct contains information about the end of a reserved path. More...

#include <pbs.h>

Public Member Functions
	PBSTileInfo ()
	Create an empty PBSTileInfo.
	PBSTileInfo (TileIndex _t, Trackdir _td, bool _okay)
	Create a PBSTileInfo with given tile, track direction and safe waiting position information.

Data Fields
TileIndex	tile
	Tile the path ends, INVALID_TILE if no valid path was found.
Trackdir	trackdir
	The reserved trackdir on the tile.
bool	okay
	True if tile is a safe waiting position, false otherwise.

Detailed Description

This struct contains information about the end of a reserved path.

Definition at line 26 of file pbs.h.

Constructor & Destructor Documentation

PBSTileInfo() [1/2]

PBSTileInfo::PBSTileInfo ( )

inline

Create an empty PBSTileInfo.

Definition at line 34 of file pbs.h.

PBSTileInfo() [2/2]

PBSTileInfo::PBSTileInfo ( TileIndex  _t, Trackdir  _td, bool  _okay  )

inline

Create a PBSTileInfo with given tile, track direction and safe waiting position information.

Parameters

_t	The tile where the path ends.
_td	The reserved track dir on the tile.
_okay	Whether the tile is a safe waiting point or not.

Definition at line 42 of file pbs.h.

Field Documentation

okay

bool PBSTileInfo::okay

True if tile is a safe waiting position, false otherwise.

Definition at line 29 of file pbs.h.

Referenced by FollowTrainReservation(), TryPathReserve(), and CYapfReserveTrack< Types >::TryReservePath().

tile

TileIndex PBSTileInfo::tile

Tile the path ends, INVALID_TILE if no valid path was found.

Definition at line 27 of file pbs.h.

Referenced by ExtendTrainReservation(), FollowTrainReservation(), GetTrainForReservation(), TryPathReserve(), CYapfReserveTrack< Types >::TryReservePath(), and YapfTrainFindNearestDepot().

trackdir

Trackdir PBSTileInfo::trackdir

The reserved trackdir on the tile.

Definition at line 28 of file pbs.h.

Referenced by CheckTrainsOnTrack(), ExtendTrainReservation(), FollowTrainReservation(), GetTrainForReservation(), TryPathReserve(), CYapfReserveTrack< Types >::TryReservePath(), and YapfTrainFindNearestDepot().

---

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

• src/pbs.h