1

#ifndef PBS_H

     2

#define PBS_H

     3

     4

/** @file pbs.h Path-Based-Signalling header file

     5

 *  @see pbs.c */

     6

     7

#include "vehicle.h"

     8

#include "tile.h"

     9

#include "map.h"

    10

#include "rail.h"

    11

    12

/**

    13

 * constants used for pbs_mode argument of npf-functions

    14

 */

    15

enum pbs_modes {

    16

	PBS_MODE_NONE = 0,    // no pbs

    17

	PBS_MODE_GREEN = 1,   // look for green exit signal from pbs block

    18

	PBS_MODE_ANY = 2,     // look for any exit signal from block

    19

};

    20

    21

/**

    22

 * constants used for v->u.rail.pbs_status

    23

 */

    24

enum PBSStatus {

    25

	PBS_STAT_NONE = 0,

    26

	PBS_STAT_HAS_PATH = 1,

    27

	PBS_STAT_NEED_PATH = 2,

    28

};

    29

    30

    31

void PBSReserveTrack(TileIndex tile, Track track);

    32

/**<

    33

 * Marks a track as reserved.

    34

 * @param tile The tile of the track.

    35

 * @param track The track to reserve, valid values 0-5.

    36

 */

    37

    38

byte PBSTileReserved(TileIndex tile);

    39

/**<

    40

 * Check which tracks are reserved on a tile.

    41

 * @param tile The tile which you want to check.

    42

 * @return The tracks reserved on that tile, each of the bits 0-5 is set when the corresponding track is reserved.

    43

 */

    44

    45

uint16 PBSTileUnavail(TileIndex tile);

    46

/**<

    47

 * Check which trackdirs are unavailable due to reserved tracks on a tile.

    48

 * @param tile The tile which you want to check.

    49

 * @return The tracks reserved on that tile, each of the bits 0-5,8-13 is set when the corresponding trackdir is unavailable.

    50

 */

    51

    52

void PBSClearTrack(TileIndex tile, Track track);

    53

/**<

    54

 * Unreserves a track.

    55

 * @param tile The tile of the track.

    56

 * @param track The track to unreserve, valid values 0-5.

    57

 */

    58

    59

void PBSClearPath(TileIndex tile, Trackdir trackdir, TileIndex end_tile, Trackdir end_trackdir);

    60

/**<

    61

 * Follows a planned(reserved) path, and unreserves the tracks.

    62

 * @param tile The tile on which the path starts

    63

 * @param trackdir The trackdirection in which the path starts

    64

 * @param end_tile The tile on which the path ends

    65

 * @param end_trackdir The trackdirection in which the path ends

    66

 */

    67

    68

bool PBSIsPbsSignal(TileIndex tile, Trackdir trackdir);

    69

/**<

    70

 * Checks if there are pbs signals on a track.

    71

 * @param tile The tile you want to check

    72

 * @param trackdir The trackdir you want to check

    73

 * @return True when there are pbs signals on that tile

    74

 */

    75

    76

bool PBSIsPbsDepot(uint tile);

    77

/**<

    78

 * Checks if a depot is inside a pbs block.

    79

 * Tis means that the block it is in needs to have at least 1 signal, and that all signals in it need to be pbs signals.

    80

 * @param tile The depot tile to check

    81

 * @return True when the depot is inside a pbs block.

    82

 */

    83

    84

#endif