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

#include "ai_error.hpp"

    10

    11

/**

    12

 * Class that handles all station related functions.

    13

 */

    14

class AIStation : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * All station related error messages.

    20

	 */

    21

	enum ErrorMessages {

    22

		/** Base for station related errors */

    23

		ERR_STATION_BASE = AIError::ERR_CAT_STATION << AIError::ERR_CAT_BIT_SIZE,

    24

    25

		/** The station size exceeds the station spread */

    26

		ERR_STATION_TOO_LARGE,                    // [STR_306C_STATION_TOO_SPREAD_OUT]

    27

    28

		/** The station is build too close to another station, airport or dock */

    29

		ERR_STATION_TOO_CLOSE_TO_ANOTHER_STATION, // [STR_300D_TOO_CLOSE_TO_ANOTHER_AIRPORT, STR_3009_TOO_CLOSE_TO_ANOTHER_STATION, STR_304C_TOO_CLOSE_TO_ANOTHER_DOCK]

    30

    31

		/** There are too many stations, airports and docks in the game */

    32

		ERR_STATION_TOO_MANY_STATIONS,            // [STR_3008_TOO_MANY_STATIONS_LOADING, STR_TOO_MANY_TRUCK_STOPS, STR_TOO_MANY_BUS_STOPS]

    33

    34

		/** There are too many stations, airports of docks in a town */

    35

		ERR_STATION_TOO_MANY_STATIONS_IN_TOWN,    // [STR_3007_TOO_MANY_STATIONS_LOADING]

    36

	};

    37

    38

	/**

    39

	 * Type of stations known in the game.

    40

	 */

    41

	enum StationType {

    42

		STATION_ANY        = 0x00, //!< All station types

    43

		STATION_TRAIN      = 0x01, //!< Train station

    44

		STATION_TRUCK_STOP = 0x02, //!< Truck station

    45

		STATION_BUS_STOP   = 0x04, //!< Bus station

    46

		STATION_AIRPORT    = 0x08, //!< Airport

    47

		STATION_DOCK       = 0x10, //!< Dock

    48

	};

    49

    50

	/**

    51

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

    52

	 * @param station_id The station to check.

    53

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

    54

	 */

    55

	static bool IsValidStation(StationID station_id);

    56

    57

	/**

    58

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

    59

	 * @param tile The tile to find the stationID of

    60

	 * @return StationID of the station.

    61

	 * @post Use IsValidStation() to see if the station is valid.

    62

	 */

    63

	static StationID GetStationID(TileIndex tile);

    64

    65

	/**

    66

	 * Get the name of a station.

    67

	 * @param station_id The station to get the name of.

    68

	 * @pre IsValidStation(station_id).

    69

	 * @return The name of the station.

    70

	 */

    71

	static char *GetName(StationID station_id);

    72

    73

	/**

    74

	 * Get the current location of a station.

    75

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

    76

	 * @pre IsValidStation(station_id).

    77

	 * @return The tile the station is currently on.

    78

	 */

    79

	static TileIndex GetLocation(StationID station_id);

    80

    81

	/**

    82

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

    83

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

    84

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

    85

	 * @pre IsValidStation(station_id).

    86

	 * @pre IsValidCargo(cargo_id).

    87

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

    88

	 */

    89

	static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);

    90

    91

	/**

    92

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

    93

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

    94

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

    95

	 * @pre IsValidStation(station_id).

    96

	 * @pre IsValidCargo(cargo_id).

    97

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

    98

	 */

    99

	static int32 GetCargoRating(StationID station_id, CargoID cargo_id);

   100

   101

	/**

   102

	 * Get the coverage radius of this type of station.

   103

	 * @param type The type of station.

   104

	 * @return The radius in tiles.

   105

	 */

   106

	static int32 GetCoverageRadius(AIStation::StationType type);

   107

   108

	/**

   109

	 * Get the manhattan distance from the tile to the AIStation::GetLocation()

   110

	 *  of the station.

   111

	 * @param station_id The station to get the distance to.

   112

	 * @param tile The tile to get the distance to.

   113

	 * @return The distance between station and tile.

   114

	 */

   115

	static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);

   116

   117

	/**

   118

	 * Get the square distance from the tile to the AIStation::GetLocation()

   119

	 *  of the station.

   120

	 * @param station_id The station to get the distance to.

   121

	 * @param tile The tile to get the distance to.

   122

	 * @return The distance between station and tile.

   123

	 */

   124

	static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);

   125

};

   126

   127

DECLARE_ENUM_AS_BIT_SET(AIStation::StationType);

   128

   129

#endif /* AI_STATION_HPP */