pbs.h File Reference

PBS support routines. More...

#include "tile_type.h"
#include "direction_type.h"
#include "track_type.h"
#include "vehicle_type.h"

Go to the source code of this file.

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

Functions
TrackBits	GetReservedTrackbits (TileIndex t)
	Get the reserved trackbits for any tile, regardless of type.
void	SetRailStationPlatformReservation (TileIndex start, DiagDirection dir, bool b)
	Set the reservation for a complete station platform.
bool	TryReserveRailTrack (TileIndex tile, Track t, bool trigger_stations=true)
	Try to reserve a specific track on a tile.
void	UnreserveRailTrack (TileIndex tile, Track t)
	Lift the reservation of a specific track on a tile.
PBSTileInfo	FollowTrainReservation (const Train *v, Vehicle **train_on_res=nullptr)
	Follow a train reservation to the last tile.
bool	IsSafeWaitingPosition (const Train *v, TileIndex tile, Trackdir trackdir, bool include_line_end, bool forbid_90deg=false)
	Determine whether a certain track on a tile is a safe position to end a path.
bool	IsWaitingPositionFree (const Train *v, TileIndex tile, Trackdir trackdir, bool forbid_90deg=false)
	Check if a safe position is free.
Train *	GetTrainForReservation (TileIndex tile, Track track)
	Find the train which has reserved a specific path.
bool	HasReservedTracks (TileIndex tile, TrackBits tracks)
	Check whether some of tracks is reserved on a tile.

Detailed Description

PBS support routines.

Definition in file pbs.h.

Function Documentation

FollowTrainReservation()

PBSTileInfo FollowTrainReservation	(	const Train *	consist,
		Vehicle **	train_on_res )

Follow a train reservation to the last tile.

Parameters

consist	the vehicle
train_on_res	Is set to a train we might encounter

Returns

The last tile of the reservation or the current train tile if no reservation present.

Definition at line 301 of file pbs.cpp.

References _settings_game, FindTrainOnTrackInfo::best, CheckTrainsOnTrack(), SpecializedVehicle< T, Type >::First(), FollowReservation(), GetAllCompatibleRailTypes(), GetDepotReservationTrackBits(), SpecializedVehicle< T, Type >::GetMovingFront(), GetOtherTunnelBridgeEnd(), Train::GetVehicleTrackdir(), IsCompatibleTrainStationTile(), IsRailDepotTile(), IsRailStationTile(), IsSafeWaitingPosition(), IsTileType(), None, PBSTileInfo::okay, Vehicle::owner, Train::railtypes, FindTrainOnTrackInfo::res, ReverseTrackdir(), PBSTileInfo::tile, Vehicle::tile, TileOffsByDiagDir(), PBSTileInfo::trackdir, TrackdirToExitdir(), Train, TunnelBridge, and BaseVehicle::type.

Referenced by ExtendTrainReservation(), TryPathReserve(), and YapfTrainFindNearestDepot().

GetReservedTrackbits()

TrackBits GetReservedTrackbits

(

TileIndex

t

)

Get the reserved trackbits for any tile, regardless of type.

Parameters

t

the tile

Returns

the reserved trackbits, or empty on nothing reserved or a tile without rail.

Definition at line 24 of file pbs.cpp.

References GetCrossingReservationTrackBits(), GetDepotReservationTrackBits(), GetRailReservationTrackBits(), GetStationReservationTrackBits(), GetTileType(), GetTunnelBridgeReservationTrackBits(), GetTunnelBridgeTransportType(), HasStationRail(), IsLevelCrossing(), IsPlainRail(), IsRailDepot(), Rail, Railway, Road, Station, and TunnelBridge.

Referenced by CmdConvertRail(), CmdRemoveSingleSignal(), FollowReservation(), FreeTrainTrackReservation(), HasReservedTracks(), IsWaitingPositionFree(), CYapfCostRailT< Types >::ReservationCost(), and TrainController().

GetTrainForReservation()

Train * GetTrainForReservation	(	TileIndex	tile,
		Track	track )

Find the train which has reserved a specific path.

Parameters

tile	A tile on the path.
track	A reserved track on the tile.

Returns

The vehicle holding the reservation or nullptr if the path is stray.

Definition at line 345 of file pbs.cpp.

References FindTrainOnTrackInfo::best, CheckTrainsOnTrack(), RailTypeInfo::compatible_railtypes, FollowReservation(), GetOtherTunnelBridgeEnd(), GetRailTypeInfo(), GetTileOwner(), GetTileRailType(), HasOnewaySignalBlockingTrackdir(), HasPbsSignalOnTrackdir(), HasReservedTracks(), IsCompatibleTrainStationTile(), IsRailStationTile(), IsTileType(), FindTrainOnTrackInfo::res, ReverseTrackdir(), PBSTileInfo::tile, TileOffsByDiagDir(), PBSTileInfo::trackdir, TrackdirToExitdir(), TrackToTrackdir(), and TunnelBridge.

Referenced by CheckFlatLandRailStation(), CmdBuildRailStation(), CmdBuildSingleSignal(), CmdConvertRail(), CmdRemoveSingleRail(), CmdRemoveSingleSignal(), DoClearBridge(), DoClearTunnel(), and RemoveFromRailBaseStation().

HasReservedTracks()

bool HasReservedTracks ( TileIndex tile, TrackBits tracks )

inline

Check whether some of tracks is reserved on a tile.

Parameters

tile	the tile
tracks	the tracks to test

Returns

true if at least on of tracks is reserved

Definition at line 58 of file pbs.h.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Any(), and GetReservedTrackbits().

Referenced by CheckNextTrainTile(), CmdBuildSingleSignal(), CmdRemoveSingleRail(), CmdRemoveSingleSignal(), DeleteLastWagon(), DrawTrackBits(), ExtendTrainReservation(), FollowReservation(), GetTrainForReservation(), IsWaitingPositionFree(), TrainController(), and TryPathReserve().

IsSafeWaitingPosition()

bool IsSafeWaitingPosition	(	const Train *	v,
		TileIndex	tile,
		Trackdir	trackdir,
		bool	include_line_end,
		bool	forbid_90deg )

Determine whether a certain track on a tile is a safe position to end a path.

Parameters

v	the vehicle to test for
tile	The tile
trackdir	The trackdir to test
include_line_end	Should end-of-line tiles be considered safe?
forbid_90deg	Don't allow trains to make 90 degree turns

Returns

True if it is a safe position

Definition at line 395 of file pbs.cpp.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Count(), DiagdirReachesTrackdirs(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::exitdir, FindFirstTrackdir(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::Follow(), GetAllCompatibleRailTypes(), GetSignalType(), GetTileRailType(), HasBlockSignalOnTrackdir(), HasPbsSignalOnTrackdir(), HasSignalOnTrackdir(), IsRailDepotTile(), IsTileType(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::new_td_bits, CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::new_tile, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::None(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::old_tile, PathOneWay, Rail90DegTurnDisallowed(), Train::railtypes, Railway, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset(), ReverseTrackdir(), TrackdirCrossesTrackdirs(), and TrackdirToTrack().

Referenced by CmdBuildSingleSignal(), ExtendTrainReservation(), FollowTrainReservation(), CYapfCostRailT< Types >::PfCalcCost(), and CYapfDestinationAnySafeTileRailT< Types >::PfDetectDestination().

IsWaitingPositionFree()

bool IsWaitingPositionFree	(	const Train *	v,
		TileIndex	tile,
		Trackdir	trackdir,
		bool	forbid_90deg )

Check if a safe position is free.

Parameters

v	the vehicle to test for
tile	The tile
trackdir	The trackdir to test
forbid_90deg	Don't allow trains to make 90 degree turns

Returns

True if the position is free

Definition at line 439 of file pbs.cpp.

References DiagdirReachesTrackdirs(), GetReservedTrackbits(), GetTileRailType(), HasBlockSignalOnTrackdir(), HasReservedTracks(), IsRailDepotTile(), Rail90DegTurnDisallowed(), TrackdirBitsToTrackBits(), TrackdirCrossesTrackdirs(), TrackdirToTrack(), and TrackOverlapsTracks().

Referenced by ExtendTrainReservation(), CYapfCostRailT< Types >::PfCalcCost(), CYapfDestinationAnySafeTileRailT< Types >::PfDetectDestination(), and CYapfReserveTrack< Types >::TryReservePath().

SetRailStationPlatformReservation()

void SetRailStationPlatformReservation	(	TileIndex	start,
		DiagDirection	dir,
		bool	b )

Set the reservation for a complete station platform.

Precondition

IsRailStationTile(start)

Parameters

start	starting tile of the platform
dir	the direction in which to follow the platform
b	the state the reservation should be set to

Definition at line 57 of file pbs.cpp.

References DiagDirToAxis(), GetRailStationAxis(), IsCompatibleTrainStationTile(), IsRailStationTile(), MarkTileDirtyByTile(), SetRailStationReservation(), TileAdd(), and TileOffsByDiagDir().

Referenced by ClearPathReservation(), CmdBuildRailStation(), DeleteLastWagon(), FreeTrainReservation(), RestoreTrainReservation(), and ReverseTrainDirection().

TryReserveRailTrack()

bool TryReserveRailTrack	(	TileIndex	tile,
		Track	t,
		bool	trigger_stations )

Try to reserve a specific track on a tile.

Parameters

tile	the tile
t	the track
trigger_stations	whether to call station randomisation trigger

Returns

true if reservation was successful, i.e. the track was free and didn't cross any other reserved tracks.

Definition at line 80 of file pbs.cpp.

References _settings_client, BaseStation::GetByTile(), GetTileTrackStatus(), GetTileType(), GetTunnelBridgeReservationTrackBits(), GetTunnelBridgeTransportType(), HasCrossingReservation(), HasDepotReservation(), HasStationRail(), HasStationReservation(), Invalid, IsBridgeTile(), IsLevelCrossing(), IsPlainRail(), IsRailDepot(), MarkBridgeDirty(), MarkTileDirtyByTile(), None, PathReservation, Rail, Railway, Road, SetCrossingReservation(), SetDepotReservation(), SetRailStationReservation(), SetTunnelBridgeReservation(), Station, TrackdirBitsToTrackBits(), TriggerStationRandomisation(), TryReserveTrack(), TunnelBridge, and UpdateLevelCrossing().

Referenced by DeleteLastWagon(), ExtendTrainReservation(), CYapfReserveTrack< Types >::ReserveSingleTrack(), Train::ReserveTrackUnderConsist(), and TrainController().

UnreserveRailTrack()

void UnreserveRailTrack	(	TileIndex	tile,
		Track	t )

Lift the reservation of a specific track on a tile.

Parameters

tile	the tile
t	the track

Definition at line 144 of file pbs.cpp.

References _settings_client, GetTileTrackStatus(), GetTileType(), GetTunnelBridgeTransportType(), HasStationRail(), Invalid, IsBridgeTile(), IsLevelCrossing(), IsPlainRail(), IsRailDepot(), MarkBridgeDirty(), MarkTileDirtyByTile(), Rail, Railway, Road, SetCrossingReservation(), SetDepotReservation(), SetRailStationReservation(), SetTunnelBridgeReservation(), Station, TrackdirBitsToTrackBits(), TunnelBridge, UnreserveTrack(), and UpdateLevelCrossing().

Referenced by ClearPathReservation(), DeleteLastWagon(), ExtendTrainReservation(), FreeTrainTrackReservation(), and CYapfReserveTrack< Types >::UnreserveSingleTrack().