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

#include "../../station_type.h"

    11

    12

/**

    13

 * Class that handles all station related functions.

    14

 */

    15

class AIStation : public AIObject {

    16

public:

    17

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

    18

    19

	/**

    20

	 * All station related error messages.

    21

	 */

    22

	enum ErrorMessages {

    23

		/** Base for station related errors */

    24

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

    25

    26

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

    27

		ERR_STATION_TOO_LARGE,                  // [STR_306C_STATION_TOO_SPREAD_OUT]

    28

    29

		/** The station is build too close to another station */

    30

		ERR_STATION_TOO_CLOSE_TO_OTHER_STATION, // [STR_300D_TOO_CLOSE_TO_ANOTHER_AIRPORT, STR_3009_TOO_CLOSE_TO_ANOTHER_STATION]

    31

	};

    32

    33

	/**

    34

	 * Type of stations known in the game.

    35

	 */

    36

	enum StationType {

    37

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

    38

		STATION_TRAIN      = 0x01, //!< Train station

    39

		STATION_TRUCK_STOP = 0x02, //!< Truck station

    40

		STATION_BUS_STOP   = 0x04, //!< Bus station

    41

		STATION_AIRPORT    = 0x08, //!< Airport

    42

		STATION_DOCK       = 0x10, //!< Dock

    43

	};

    44

    45

	/**

    46

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

    47

	 * @param station_id The station to check.

    48

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

    49

	 */

    50

	static bool IsValidStation(StationID station_id);

    51

    52

	/**

    53

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

    54

	 * @param tile The tile to find the stationID of

    55

	 * @return StationID of the station.

    56

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

    57

	 */

    58

	static StationID GetStationID(TileIndex tile);

    59

    60

	/**

    61

	 * Get the name of a station.

    62

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

    63

	 * @pre IsValidStation(station_id).

    64

	 * @return The name of the station.

    65

	 */

    66

	static char *GetName(StationID station_id);

    67

    68

	/**

    69

	 * Get the current location of a station.

    70

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

    71

	 * @pre IsValidStation(station_id).

    72

	 * @return The tile the station is currently on.

    73

	 */

    74

	static TileIndex GetLocation(StationID station_id);

    75

    76

	/**

    77

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

    78

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

    79

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

    80

	 * @pre IsValidStation(station_id).

    81

	 * @pre IsValidCargo(cargo_id).

    82

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

    83

	 */

    84

	static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);

    85

    86

	/**

    87

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

    88

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

    89

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

    90

	 * @pre IsValidStation(station_id).

    91

	 * @pre IsValidCargo(cargo_id).

    92

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

    93

	 */

    94

	static int32 GetCargoRating(StationID station_id, CargoID cargo_id);

    95

    96

	/**

    97

	 * Get the coverage radius of this type of station.

    98

	 * @param type The type of station.

    99

	 * @return The radius in tiles.

   100

	 */

   101

	static int32 GetCoverageRadius(AIStation::StationType type);

   102

   103

	/**

   104

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

   105

	 *  of the station.

   106

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

   107

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

   108

	 * @return The distance between station and tile.

   109

	 */

   110

	static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);

   111

   112

	/**

   113

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

   114

	 *  of the station.

   115

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

   116

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

   117

	 * @return The distance between station and tile.

   118

	 */

   119

	static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);

   120

};

   121

   122

DECLARE_ENUM_AS_BIT_SET(AIStation::StationType);

   123

   124

#endif /* AI_STATION_HPP */