1

/* $Id$ */

     2

     3

/** @file ai_industry.hpp Everything to query and build industries. */

     4

     5

#ifndef AI_INDUSTRY_HPP

     6

#define AI_INDUSTRY_HPP

     7

     8

#include "ai_object.hpp"

     9

#include "../../industry.h"

    10

    11

/**

    12

 * Class that handles all industry related functions.

    13

 */

    14

class AIIndustry : public AIObject {

    15

public:

    16

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

    17

    18

	/**

    19

	 * Gets the maximum industry index; there are no valid industries with a

    20

	 *   higher index.

    21

	 * @return The maximum industry index.

    22

	 * @post Return value is always non-negative.

    23

	 */

    24

	static IndustryID GetMaxIndustryID();

    25

    26

	/**

    27

	 * Gets the number of industries. This is different than GetMaxIndustryID()

    28

	 *   because of the way OpenTTD works internally.

    29

	 * @return The number of industries.

    30

	 * @post Return value is always non-negative.

    31

	 */

    32

	static int32 GetIndustryCount();

    33

    34

	/**

    35

	 * Checks whether the given industry index is valid.

    36

	 * @param industry_id The index to check.

    37

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

    38

	 */

    39

	static bool IsValidIndustry(IndustryID industry_id);

    40

    41

	/**

    42

	 * Get the name of the industry.

    43

	 * @param industry_id The industry to get the name of.

    44

	 * @pre IsValidIndustry(industry_id).

    45

	 * @return The name of the industry.

    46

	 */

    47

	static char *GetName(IndustryID industry_id);

    48

    49

	/**

    50

	 * Gets the production of a cargo of the industry.

    51

	 * @param industry_id The index of the industry.

    52

	 * @param cargo_id The index of the cargo.

    53

	 * @pre IsValidIndustry(industry_id).

    54

	 * @pre AICargo::IsValidCargo(cargo_id).

    55

	 * @return The production of the cargo for this industry, or -1 if

    56

	 *   this industry doesn't produce this cargo.

    57

	 */

    58

	static int32 GetProduction(IndustryID industry_id, CargoID cargo_id);

    59

    60

	/**

    61

	 * See if an industry accepts a certain cargo.

    62

	 * @param industry_id The index of the industry.

    63

	 * @param cargo_id The index of the cargo.

    64

	 * @pre IsValidIndustry(industry_id).

    65

	 * @pre AICargo::IsValidCargo(cargo_id).

    66

	 * @return The production of the cargo for this industry.

    67

	 */

    68

	static bool IsCargoAccepted(IndustryID industry_id, CargoID cargo_id);

    69

    70

	/**

    71

	 * Get the total last month's production of the given cargo at an industry.

    72

	 * @param industry_id The index of the industry.

    73

	 * @param cargo_id The index of the cargo.

    74

	 * @pre IsValidIndustry(industry_id).

    75

	 * @pre AICargo::IsValidCargo(cargo_id).

    76

	 * @return The last month's production of the given cargo for this industry.

    77

	 */

    78

	static uint16 GetLastMonthProduction(IndustryID industry_id, CargoID cargo_id);

    79

    80

	/**

    81

	 * Get the total amount of cargo transported from an industry last month.

    82

	 * @param industry_id The index of the industry.

    83

	 * @param cargo_id The index of the cargo.

    84

	 * @pre IsValidIndustry(industry_id).

    85

	 * @pre AICargo::IsValidCargo(cargo_id).

    86

	 * @return The amount of given cargo transported from this industry last month.

    87

	 */

    88

	static uint16 GetLastMonthTransported(IndustryID industry_id, CargoID cargo_id);

    89

    90

	/**

    91

	 * Gets the location of the industry.

    92

	 * @param industry_id The index of the industry.

    93

	 * @pre IsValidIndustry(industry_id).

    94

	 * @return The location of the industry.

    95

	 */

    96

	static TileIndex GetLocation(IndustryID industry_id);

    97

    98

	/**

    99

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

   100

	 *  of the industry.

   101

	 * @param industry_id The industry to get the distance to.

   102

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

   103

	 * @pre IsValidIndustry(industry_id).

   104

	 * @pre AIMap::IsValidTile(tile).

   105

	 * @return The distance between industry and tile.

   106

	 */

   107

	static int32 GetDistanceManhattanToTile(IndustryID industry_id, TileIndex tile);

   108

   109

	/**

   110

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

   111

	 *  of the industry.

   112

	 * @param industry_id The industry to get the distance to.

   113

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

   114

	 * @pre IsValidIndustry(industry_id).

   115

	 * @pre AIMap::IsValidTile(tile).

   116

	 * @return The distance between industry and tile.

   117

	 */

   118

	static int32 GetDistanceSquareToTile(IndustryID industry_id, TileIndex tile);

   119

};

   120

   121

#endif /* AI_INDUSTRY_HPP */