1

/* $Id$ */

     2

     3

/** @file ai_industrylist_valuator.hpp all the valuators for AIIndustryList */

     4

     5

#ifndef AI_INDUSTRYLIST_VALUATOR_HPP

     6

#define AI_INDUSTRYLIST_VALUATOR_HPP

     7

     8

#include "ai_abstractlist.hpp"

     9

    10

/**

    11

 * Get the production rate of the cargo for entries in an AIIndustryList

    12

 *  instance. This is the amount of production you can expect in a month.

    13

 * @note Resulting items are of the type int32.

    14

 * @note Can only operate on an AIIndustryList instance.

    15

 * @ingroup AIIndustryList

    16

 */

    17

class AIIndustryList_vProduction : public AIAbstractList::Valuator {

    18

public:

    19

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

    20

    21

	/**

    22

	 * @param cargo_id The cargo to check the production rate of.

    23

	 */

    24

	AIIndustryList_vProduction(CargoID cargo_id) :

    25

		cargo_id(cargo_id)

    26

	{}

    27

    28

private:

    29

	CargoID cargo_id;

    30

    31

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

    32

	int32 Valuate(int32 industry) const;

    33

};

    34

    35

/**

    36

 * See which entries in the AIIndustryList instance accepts a given cargo.

    37

 * @note Resulting items are of the type bool.

    38

 * @note Can only operate on an AIIndustryList instance.

    39

 * @ingroup AIIndustryList

    40

 */

    41

class AIIndustryList_vCargoAccepted : public AIAbstractList::Valuator {

    42

public:

    43

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

    44

    45

	/**

    46

	 * @param cargo_id Check if this cargo is accepted.

    47

	 */

    48

	AIIndustryList_vCargoAccepted(CargoID cargo_id) :

    49

		cargo_id(cargo_id)

    50

	{}

    51

    52

private:

    53

	CargoID cargo_id;

    54

    55

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

    56

	int32 Valuate(int32 industry) const;

    57

};

    58

    59

/**

    60

 * Get the location for entries in an AIIndustryList instance.

    61

 * @note Resulting items are of the type TileIndex.

    62

 * @note Can only operate on an AIIndustryList instance.

    63

 * @ingroup AIIndustryList

    64

 */

    65

class AIIndustryList_vLocation : public AIAbstractList::Valuator {

    66

public:

    67

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

    68

    69

private:

    70

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

    71

	int32 Valuate(int32 industry) const;

    72

};

    73

    74

/**

    75

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

    76

 * @note Resulting items are of the type uint32.

    77

 * @note Can only operate on an AIIndustryList instance.

    78

 * @ingroup AIIndustryList

    79

 */

    80

class AIIndustryList_vDistanceManhattanToTile : public AIAbstractList::Valuator {

    81

public:

    82

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

    83

    84

	/**

    85

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

    86

	 */

    87

	AIIndustryList_vDistanceManhattanToTile(TileIndex tile) :

    88

		tile(tile)

    89

	{}

    90

    91

private:

    92

	TileIndex tile;

    93

    94

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

    95

	int32 Valuate(int32 station) const;

    96

};

    97

    98

/**

    99

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

   100

 * @note Resulting items are of the type uint32.

   101

 * @note Can only operate on an AIIndustryList instance.

   102

 * @ingroup AIIndustryList

   103

 */

   104

class AIIndustryList_vDistanceSquareToTile : public AIAbstractList::Valuator {

   105

public:

   106

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

   107

   108

	/**

   109

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

   110

	 */

   111

	AIIndustryList_vDistanceSquareToTile(TileIndex tile) :

   112

		tile(tile)

   113

	{}

   114

   115

private:

   116

	TileIndex tile;

   117

   118

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

   119

	int32 Valuate(int32 station) const;

   120

};

   121

   122

#endif /* AI_INDUSTRYLIST_VALUATOR_HPP */