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

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

    17

	 */

    18

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

    19

    20

	/**

    21

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

    22

	 * @param station_id the station to check.

    23

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

    24

	 */

    25

	static bool IsValidStation(StationID station_id);

    26

    27

	/**

    36

	 * Get the current location of a station.

    37

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

    38

	 * @pre IsValidStation(station_id).

    39

	 * @return the tile the station is currently on.

    40

	 */

    41

	static TileIndex GetLocation(StationID station_id);

    42

    43

	/**

    44

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

    45

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

    46

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

    47

	 * @pre IsValidStation(station_id).

    48

	 * @pre IsValidCargo(cargo_id).

    49

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

    50

	 */

    51

	static int32 GetCargoWaiting(StationID station_id, CargoID cargo_id);

    52

    53

	/**

    54

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

    55

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

    56

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

    57

	 * @pre IsValidStation(station_id).

    58

	 * @pre IsValidCargo(cargo_id).

    59

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

    60

	 */

    61

	static int32 GetCargoRating(StationID station_id, CargoID cargo_id);

    62

};

    63

    64

#endif /* AI_STATION_HPP */