1

/* $Id$ */

     2

     3

/** @file ai_stationlist_valuator.hpp all the valuators for AIStationList */

     4

     5

#ifndef AI_STATIONLIST_VALUATOR_HPP

     6

#define AI_STATIONLIST_VALUATOR_HPP

     7

     8

#include "ai_abstractlist.hpp"

     9

    10

/**

    11

 * Get the location for entries in an AIStationList instance.

    12

 * @note Resulting items are of the type TileIndex.

    13

 * @note Can only operate on an AIStationList instance.

    14

 * @ingroup AIStationList

    15

 */

    16

class AIStationList_vLocation : public AIAbstractList::Valuator {

    17

public:

    18

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

    19

    20

private:

    21

	const char *GetListName() const { return "AIStationList"; }

    22

	int32 Valuate(int32 station_id) const;

    23

};

    24

    25

/**

    26

 * Get the cargo-waiting for entries in an AIStationList instance.

    27

 * @note Resulting items are of the type uint32 (units of cargo).

    28

 * @note Can only operate on an AIStationList instance.

    29

 * @ingroup AIStationList

    30

 */

    31

class AIStationList_vCargoWaiting : public AIAbstractList::Valuator {

    32

public:

    33

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

    34

    35

	/**

    36

	 * @param cargo_id The cargo of which you want to get the amount of units waiting for.

    37

	 */

    38

	AIStationList_vCargoWaiting(CargoID cargo_id) :

    39

		cargo_id(cargo_id)

    40

	{}

    41

    42

private:

    43

	CargoID cargo_id;

    44

    45

	const char *GetListName() const { return "AIStationList"; }

    46

	int32 Valuate(int32 station_id) const;

    47

};

    48

    49

/**

    50

 * Get the cargo rating for entries in an AIStationList instance.

    51

 * @note Resulting items are of the type int32 (percent).

    52

 * @note Can only operate on an AIStationList instance.

    53

 * @ingroup AIStationList

    54

 */

    55

class AIStationList_vCargoRating : public AIAbstractList::Valuator {

    56

public:

    57

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

    58

    59

	/**

    60

	 * @param cargo_id The cargo of which you want to get the rating of.

    61

	 */

    62

	AIStationList_vCargoRating(CargoID cargo_id) :

    63

		cargo_id(cargo_id)

    64

	{}

    65

    66

private:

    67

	CargoID cargo_id;

    68

    69

	const char *GetListName() const { return "AIStationList"; }

    70

	int32 Valuate(int32 station_id) const;

    71

};

    72

    73

/**

    74

 * Get the manhattan distance to a tile for entries in an AIStationList instance.

    75

 * @note Resulting items are of the type uint32.

    76

 * @note Can only operate on an AIStationList instance.

    77

 * @ingroup AIStationList

    78

 */

    79

class AIStationList_vDistanceManhattanToTile : public AIAbstractList::Valuator {

    80

public:

    81

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

    82

    83

	/**

    84

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

    85

	 */

    86

	AIStationList_vDistanceManhattanToTile(TileIndex tile) :

    87

		tile(tile)

    88

	{}

    89

    90

private:

    91

	TileIndex tile;

    92

    93

	const char *GetListName() const { return "AIStationList"; }

    94

	int32 Valuate(int32 station_id) const;

    95

};

    96

    97

/**

    98

 * Get the square distance to a tile for entries in an AIStationList instance.

    99

 * @note Resulting items are of the type uint32.

   100

 * @note Can only operate on an AIStationList instance.

   101

 * @ingroup AIStationList

   102

 */

   103

class AIStationList_vDistanceSquareToTile : public AIAbstractList::Valuator {

   104

public:

   105

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

   106

   107

	/**

   108

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

   109

	 */

   110

	AIStationList_vDistanceSquareToTile(TileIndex tile) :

   111

		tile(tile)

   112

	{}

   113

   114

private:

   115

	TileIndex tile;

   116

   117

	const char *GetListName() const { return "AIStationList"; }

   118

	int32 Valuate(int32 station_id) const;

   119

};

   120

   121

#endif /* AI_STATIONLIST_VALUATOR_HPP */