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

    10

/**

    11

 * Class that handles all industry related functions.

    12

 */

    13

class AIIndustry : public AIObject {

    14

public:

    15

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

    16

    17

	/**

    18

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

    19

	 *   higher index.

    20

	 * @return The maximum industry index.

    21

	 * @post Return value is always non-negative.

    22

	 */

    23

	static IndustryID GetMaxIndustryID();

    24

    25

	/**

    26

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

    27

	 *   because of the way OpenTTD works internally.

    28

	 * @return The number of industries.

    29

	 * @post Return value is always non-negative.

    30

	 */

    31

	static int32 GetIndustryCount();

    32

    33

	/**

    34

	 * Checks whether the given industry index is valid.

    35

	 * @param industry_id The index to check.

    36

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

    37

	 */

    38

	static bool IsValidIndustry(IndustryID industry_id);

    39

    40

	/**

    41

	 * Get the name of the industry.

    42

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

    43

	 * @pre IsValidIndustry(industry_id).

    44

	 * @return The name of the industry.

    45

	 */

    46

	static char *GetName(IndustryID industry_id);

    47

    48

	/**

    49

	 * Gets the production of a cargo of the industry.

    50

	 * @param industry_id The index of the industry.

    51

	 * @param cargo_id The index of the cargo.

    52

	 * @pre IsValidIndustry(industry_id).

    53

	 * @pre AICargo::IsValidCargo(cargo_id).

    54

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

    55

	 *   this industry doesn't produce this cargo.

    56

	 */

    57

	static int32 GetProduction(IndustryID industry_id, CargoID cargo_id);

    58

    59

	/**

    60

	 * See if an industry accepts a certain cargo.

    61

	 * @param industry_id The index of the industry.

    62

	 * @param cargo_id The index of the cargo.

    63

	 * @pre IsValidIndustry(industry_id).

    64

	 * @pre AICargo::IsValidCargo(cargo_id).

    65

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

    66

	 */

    67

	static bool IsCargoAccepted(IndustryID industry_id, CargoID cargo_id);

    68

    69

	/**

    70

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

    71

	 * @param industry_id The index of the industry.

    72

	 * @param cargo_id The index of the cargo.

    73

	 * @pre IsValidIndustry(industry_id).

    74

	 * @pre AICargo::IsValidCargo(cargo_id).

    75

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

    76

	 */

    77

	static uint16 GetLastMonthProduction(IndustryID industry_id, CargoID cargo_id);

    78

    79

	/**

    80

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

    81

	 * @param industry_id The index of the industry.

    82

	 * @param cargo_id The index of the cargo.

    83

	 * @pre IsValidIndustry(industry_id).

    84

	 * @pre AICargo::IsValidCargo(cargo_id).

    85

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

    86

	 */

    87

	static uint16 GetLastMonthTransported(IndustryID industry_id, CargoID cargo_id);

    88

    89

	/**

    90

	 * Gets the location of the industry.

    91

	 * @param industry_id The index of the industry.

    92

	 * @pre IsValidIndustry(industry_id).

    93

	 * @return The location of the industry.

    94

	 */

    95

	static TileIndex GetLocation(IndustryID industry_id);

    96

    97

	/**

    98

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

    99

	 *  of the industry.

   100

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

   101

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

   102

	 * @pre IsValidIndustry(industry_id).

   103

	 * @pre AIMap::IsValidTile(tile).

   104

	 * @return The distance between industry and tile.

   105

	 */

   106

	static int32 GetDistanceManhattanToTile(IndustryID industry_id, TileIndex tile);

   107

   108

	/**

   109

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

   110

	 *  of the industry.

   111

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

   112

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

   113

	 * @pre IsValidIndustry(industry_id).

   114

	 * @pre AIMap::IsValidTile(tile).

   115

	 * @return The distance between industry and tile.

   116

	 */

   117

	static int32 GetDistanceSquareToTile(IndustryID industry_id, TileIndex tile);

   118

   119

	/**

   120

	 * Is this industry built on water.

   121

	 * @param industry_id The index of the industry.

   122

	 * @pre IsValidIndustry(industry_id).

   123

	 * @return True when the industry is built on water.

   124

	 */

   125

	static bool IsBuiltOnWater(IndustryID industry_id);

   126

   127

	/**

   128

	 * Does this industry have a heliport and dock?

   129

	 * @param industry_id The index of the industry.

   130

	 * @pre IsValidIndustry(industry_id).

   131

	 * @return True when the industry has a heliport and dock.

   132

	 */

   133

	static bool HasHeliportAndDock(IndustryID industry_id);

   134

   135

	/**

   136

	 * Gets the location of the industry's heliport/dock.

   137

	 * @param industry_id The index of the industry.

   138

	 * @pre IsValidIndustry(industry_id).

   139

	 * @pre HasHeliportAndDock(industry_id).

   140

	 * @return The location of the industry's heliport/dock.

   141

	 */

   142

	static TileIndex GetHeliportAndDockLocation(IndustryID industry_id);

   143

};

   144

   145

#endif /* AI_INDUSTRY_HPP */