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 "ai_road.hpp"

    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, airport or dock */

    30

		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]

    31

    32

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

    33

		ERR_STATION_TOO_MANY_STATIONS,            // [STR_3008_TOO_MANY_STATIONS_LOADING, STR_TOO_MANY_TRUCK_STOPS, STR_TOO_MANY_BUS_STOPS]

    34

    35

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

    36

		ERR_STATION_TOO_MANY_STATIONS_IN_TOWN,    // [STR_3007_TOO_MANY_STATIONS_LOADING]

    37

	};

    38

    39

	/**

    40

	 * Type of stations known in the game.

    41

	 */

    42

	enum StationType {

    43

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

    44

		STATION_TRAIN      = 0x01, //!< Train station

    45

		STATION_TRUCK_STOP = 0x02, //!< Truck station

    46

		STATION_BUS_STOP   = 0x04, //!< Bus station

    47

		STATION_AIRPORT    = 0x08, //!< Airport

    48

		STATION_DOCK       = 0x10, //!< Dock

    49

	};

    50

    51

	/**

    52

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

    53

	 * @param station_id The station to check.

    54

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

    55

	 */

    56

	static bool IsValidStation(StationID station_id);

    57

    58

	/**

    59

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

    60

	 * @param tile The tile to find the stationID of

    61

	 * @return StationID of the station.

    62

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

    63

	 */

    64

	static StationID GetStationID(TileIndex tile);

    65

    66

	/**

    67

	 * Get the name of a station.

    68

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

    69

	 * @pre IsValidStation(station_id).

    70

	 * @return The name of the station.

    71

	 */

    72

	static char *GetName(StationID station_id);

    73

    74

	/**

    75

	 * Set the name this station.

    76

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

    77

	 * @param name The new name of the station.

    78

	 * @pre IsValidStation(station_id).

    79

	 * @pre 'name' must have at least one character.

    80

	 * @exception AIError::ERR_NAME_IS_NOT_UNIQUE

    81

	 * @return True if the name was changed.

    82

	 */

    83

	static bool SetName(StationID station_id, const char *name);

    84

    85

	/**

    86

	 * Get the current location of a station.

    87

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

    88

	 * @pre IsValidStation(station_id).

    89

	 * @return The tile the station is currently on.

    90

	 */

    91

	static TileIndex GetLocation(StationID station_id);

    92

    93

	/**

    94

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

    95

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

    96

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

    97

	 * @pre IsValidStation(station_id).

    98

	 * @pre IsValidCargo(cargo_id).

    99

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

   100

	 */

   101

	static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);

   102

   103

	/**

   104

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

   105

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

   106

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

   107

	 * @pre IsValidStation(station_id).

   108

	 * @pre IsValidCargo(cargo_id).

   109

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

   110

	 */

   111

	static int32 GetCargoRating(StationID station_id, CargoID cargo_id);

   112

   113

	/**

   114

	 * Get the coverage radius of this type of station.

   115

	 * @param type The type of station.

   116

	 * @return The radius in tiles.

   117

	 */

   118

	static int32 GetCoverageRadius(AIStation::StationType type);

   119

   120

	/**

   121

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

   122

	 *  of the station.

   123

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

   124

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

   125

	 * @pre IsValidStation(station_id).

   126

	 * @return The distance between station and tile.

   127

	 */

   128

	static int32 GetDistanceManhattanToTile(StationID station_id, TileIndex tile);

   129

   130

	/**

   131

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

   132

	 *  of the station.

   133

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

   134

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

   135

	 * @pre IsValidStation(station_id).

   136

	 * @return The distance between station and tile.

   137

	 */

   138

	static int32 GetDistanceSquareToTile(StationID station_id, TileIndex tile);

   139

   140

	/**

   141

	 * Find out if this station is within the rating influence of a town.

   142

	 *  Stations within the radius influence the rating of the town.

   143

	 * @param station_id The station to check.

   144

	 * @param town_id The town to check.

   145

	 * @return True if the tile is within the rating influence of the town.

   146

	 */

   147

	static bool IsWithinTownInfluence(StationID station_id, TownID town_id);

   148

   149

	/**

   150

	 * Check if any part of the station contains a station of the type

   151

	 *  RoadType.

   152

	 * @param station_id The station to look at.

   153

	 * @param road_type The RoadType to look for.

   154

	 * @return True if the station has a station part of the type RoadType.

   155

	 */

   156

	static bool HasRoadType(StationID station_id, AIRoad::RoadType road_type);

   157

};

   158

   159

DECLARE_ENUM_AS_BIT_SET(AIStation::StationType);

   160

   161

#endif /* AI_STATION_HPP */