1

/* $Id$ */

     2

     3

/** @file ai_station.hpp Everything to query and build stations */

     4

     5

#ifndef AI_STATION_HPP

     6

#define AI_STATION_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all station related functions.

    12

 */

    13

class AIStation : public AIObject {

    14

public:

    15

	/**

    16

	 * Type of stations known in the game.

    17

	 */

    18

	enum StationType {

    19

		STATION_ANY        = 0x00,

    20

		STATION_TRAIN      = 0x01,

    21

		STATION_TRUCK_STOP = 0x02,

    22

		STATION_BUS_STOP   = 0x04,

    23

		STATION_AIRPORT    = 0x08,

    24

		STATION_DOCK       = 0x10,

    25

	};

    26

    27

	/**

    28

	 * The name of the class, needed by several sub-processes.

    29

	 */

    30

	static const char *GetClassName() { return "AIStation"; }

    31

    32

	/**

    33

	 * Checks whether the given station is valid and owned by you.

    34

	 * @param station_id the station to check.

    35

	 * @return true if and only if the station is valid.

    36

	 */

    37

	static bool IsValidStation(StationID station_id);

    38

    39

	/**

    40

	 * Get the stationID of a tile, if there is a station.

    41

	 * @param tile the tile to find the stationID of

    42

	 * @return StationID of the station.

    43

	 * @post use IsValidStation to see if the station is valid.

    44

	 */

    45

	static StationID GetStationID(TileIndex tile);

    46

    47

	/**

    56

	 * Get the current location of a station.

    57

	 * @param station_id the station to get the location of.

    58

	 * @pre IsValidStation(station_id).

    59

	 * @return the tile the station is currently on.

    60

	 */

    61

	static TileIndex GetLocation(StationID station_id);

    62

    63

	/**

    64

	 * See how much cargo there is waiting on a station.

    65

	 * @param station_id the station to get the cargo-waiting of.

    66

	 * @param cargo_id the cargo to get the cargo-waiting of.

    67

	 * @pre IsValidStation(station_id).

    68

	 * @pre IsValidCargo(cargo_id).

    69

	 * @return the amount of units waiting at the station.

    70

	 */

    71

	static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);

    72

    73

	/**

    74

	 * See how high the rating is of a cargo on a station.

    75

	 * @param station_id the station to get the cargo-rating of.

    76

	 * @param cargo_id the cargo to get the cargo-rating of.

    77

	 * @pre IsValidStation(station_id).

    78

	 * @pre IsValidCargo(cargo_id).

    79

	 * @return the rating in percent of the cargo on the station.

    80

	 */

    81

	static int32 GetCargoRating(StationID station_id, CargoID cargo_id);

    82

    83

	/**

    84

	 * Get the coverage radius of this type of station.

    85

	 * @param type the type of station.

    86

	 * @return the radius in tiles.

    87

	 */

    88

	static int32 GetCoverageRadius(AIStation::StationType type);

    89

};

    90

DECLARE_ENUM_AS_BIT_SET(AIStation::StationType);

    91

    92

#endif /* AI_STATION_HPP */