1

/* $Id$ */

     2

     3

/** @file ai_tilelist_valuator.hpp all the valuators for tilelist */

     4

     5

#ifndef AI_TILELIST_VALUATOR_HPP

     6

#define AI_TILELIST_VALUATOR_HPP

     7

     8

#include "ai_abstractlist.hpp"

     9

    10

/**

    11

 * Check if tiles are buildable for entries in an AITileList instance.

    12

 * @note resulting items are of the type bool (0 = not buildable, 1 = buildable)

    13

 * @note the input items are of the type TileIndex

    14

 */

    15

class AITileListBuildable : public AIAbstractList::Valuator {

    16

public:

    17

	/**

    18

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

    19

	 */

    20

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

    21

    22

private:

    23

	int32 Valuate(int32 tile) const;

    24

};

    25

    26

/**

    43

 * Check if tiles are buildable in a rectangle around entries in an AITileList instance, with the entry in the list as top-left.

    44

 * @note resulting items are of the type bool (0 = not buildable, 1 = buildable)

    45

 * @note the input items are of the type TileIndex

    46

 */

    47

class AITileListBuildableRectangle : public AIAbstractList::Valuator {

    48

public:

    49

	/**

    50

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

    51

	 */

    52

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

    53

    54

	/**

    55

	 * Custom constructor, we want a width and height as parameter.

    56

	 */

    57

	AITileListBuildableRectangle(uint width, uint height) { this->width = width; this->height = height; }

    58

    59

private:

    60

	uint width, height;

    61

    62

	int32 Valuate(int32 tile) const;

    63

};

    64

    65

/**

    66

 * Check how tiles in an AITileList instance are sloped.

    67

 * @note resulting items are of the type int32 (0 = flat, > 1 = slope)

    68

 * @note the input items are of the type TileIndex

    69

 */

    70

class AITileListSlope : public AIAbstractList::Valuator {

    71

public:

    72

	/**

    73

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

    74

	 */

    75

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

    76

    77

private:

    78

	int32 Valuate(int32 tile) const;

    79

};

    80

    81

/**

    82

 * Count for each entry in AITileList the amount of neighbours that contain road.

    83

 *   This is a value between 0 and 4, as it only check horizontal and vertical.

    84

 * @note resulting items are of the type int32 (the amount of neighbour road tiles, value between 0 and 4)

    85

 * @note the input items are of the type TileIndex

    86

 */

    87

class AITileListNeighbourRoadCount : public AIAbstractList::Valuator {

    88

public:

    89

	/**

    90

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

    91

	 */

    92

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

    93

    94

private:

    95

	int32 Valuate(int32 tile) const;

    96

};

    97

    98

/**

    99

 * Check if the tiles in AITileList have a piece of road on them.

   100

 * @note resulting items are of the type bool (0 = no road, 1 = road)

   101

 * @note the input items are of the type TileIndex

   102

 */

   103

class AITileListRoadTile : public AIAbstractList::Valuator {

   104

public:

   105

	/**

   106

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

   107

	 */

   108

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

   109

   110

private:

   111

	int32 Valuate(int32 tile) const;

   112

};

   113

   114

/**

   115

 * Get the amount of estimated accepted cargo for all tiles in AITileList.

   116

 * If this value is >= 8, it means it will accept this cargo. For passengers

   117

 *  and mail it is also a good indicator how much cargo would be brought to

   118

 *  the station.

   119

 * @post values < 8 means this tile does not accept this cargo.

   120

 * @note resulting items are of the type int32 (indicating acceptance)

   121

 * @note the input items are of the type TileIndex

   122

 */

   123

class AITileListCargoAcceptance : public AIAbstractList::Valuator {

   124

public:

   125

	/**

   126

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

   127

	 */

   128

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

   129

   130

	/**

   131

	 * Custom constructor, we want a cargo-type as parameter.

   132

	 */

   133

	AITileListCargoAcceptance(CargoID cargo_type, uint width, uint height, uint radius) { this->cargo_type = cargo_type; this->width = width; this->height = height; this->radius = radius; }

   134

   135

private:

   136

	CargoID cargo_type;

   137

	uint width, height, radius;

   138

   139

	int32 Valuate(int32 tile) const;

   140

};

   141

   142

/**

   143

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

   144

 * @note resulting items are of the type distance

   145

 * @note the input items are of the type TileIndex

   146

 */

   147

class AITileListDistanceManhattanToTile : public AIAbstractList::Valuator {

   148

public:

   149

	/**

   150

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

   151

	 */

   152

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

   153

   154

	/**

   155

	 * Custom constructor, we want a tile as parameter.

   156

	 */

   157

	AITileListDistanceManhattanToTile(TileIndex tile) { this->tile = tile; }

   158

   159

private:

   160

	TileIndex tile;

   161

   162

	int32 Valuate(int32 station) const;

   163

};

   164

   165

/**

   166

 * Get the sqsuare distance to a tile for entries in an AITileList instance.

   167

 * @note resulting items are of the type distance

   168

 * @note the input items are of the type TileIndex

   169

 */

   170

class AITileListDistanceSquareToTile : public AIAbstractList::Valuator {

   171

public:

   172

	/**

   173

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

   174

	 */

   175

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

   176

   177

	/**

   178

	 * Custom constructor, we want a tile as parameter.

   179

	 */

   180

	AITileListDistanceSquareToTile(TileIndex tile) { this->tile = tile; }

   181

   182

private:

   183

	TileIndex tile;

   184

   185

	int32 Valuate(int32 station) const;

   186

};

   187

   188

   189

#endif /* AI_TILELIST_VALUATOR_HPP */