1

/* $Id$ */

     2

     3

#ifndef PBS_H

     4

#define PBS_H

     5

     6

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

     7

 *  @see pbs.c */

     8

     9

#include "vehicle.h"

    10

#include "map.h"

    11

#include "rail.h"

    12

    13

/**

    14

 * constants used for pbs_mode argument of npf-functions

    15

 */

    16

enum pbs_modes {

    17

	PBS_MODE_NONE = 0,    // no pbs

    18

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

    19

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

    20

};

    21

    22

/**

    23

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

    24

 */

    25

enum PBSStatus {

    26

	PBS_STAT_NONE = 0,

    27

	PBS_STAT_HAS_PATH = 1,

    28

	PBS_STAT_NEED_PATH = 2,

    29

};

    30

    31

    32

void PBSReserveTrack(TileIndex tile, Track track);

    33

/**<

    34

 * Marks a track as reserved.

    35

 * @param tile The tile of the track.

    36

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

    37

 */

    38

    39

byte PBSTileReserved(TileIndex tile);

    40

/**<

    41

 * Check which tracks are reserved on a tile.

    42

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

    43

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

    44

 */

    45

    46

uint16 PBSTileUnavail(TileIndex tile);

    47

/**<

    48

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

    49

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

    50

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

    51

 */

    52

    53

void PBSClearTrack(TileIndex tile, Track track);

    54

/**<

    55

 * Unreserves a track.

    56

 * @param tile The tile of the track.

    57

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

    58

 */

    59

    60

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

    61

/**<

    62

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

    63

 * @param tile The tile on which the path starts

    64

 * @param trackdir The trackdirection in which the path starts

    65

 * @param end_tile The tile on which the path ends

    66

 * @param end_trackdir The trackdirection in which the path ends

    67

 */

    68

    69

bool PBSIsPbsSignal(TileIndex tile, Trackdir trackdir);

    70

/**<

    71

 * Checks if there are pbs signals on a track.

    72

 * @param tile The tile you want to check

    73

 * @param trackdir The trackdir you want to check

    74

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

    75

 */

    76

    77

bool PBSIsPbsSegment(uint tile, Trackdir trackdir);

    78

/**<

    79

 * Checks if a signal/depot leads to a pbs block.

    80

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

    81

 * @param tile The tile to check

    82

 * @param trackdir The direction in which to check

    83

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

    84

 */

    85

    86

#endif /* PBS_H */