1

/* $Id$ */

     2

     3

/** @file ai_industry.hpp Everything to query about 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

	/**

    16

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

    17

	 */

    18

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

    19

    20

	/**

    21

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

    22

	 *   higher index.

    23

	 * @return the maximum industry index.

    24

	 * @post return value is always non-negative.

    25

	 */

    26

	IndustryID GetMaxIndustryID();

    27

    28

	/**

    29

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

    30

	 *   because of the way OpenTTD works internally.

    31

	 * @return the number of industries.

    32

	 * @post return value is always non-negative.

    33

	 */

    34

	int32 GetIndustryCount();

    35

    36

	/**

    37

	 * Checks whether the given industry index is valid.

    38

	 * @param industry_id the index to check.

    39

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

    40

	 */

    41

	static bool IsValidIndustry(IndustryID industry_id);

    42

    43

	/**

    44

	 * Get the name of the industry.

    45

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

    46

	 * @pre industry_id has to be valid (use IsValidIndustry()).

    47

	 * @return the name of the industry.

    48

	 * @note the returned name must be free'd (C++ only).

    49

	 */

    50

	char *GetName(IndustryID industry_id);

    51

    52

	/**

    53

	 * Gets the production of a cargo of the industry.

    54

	 * @param industry_id the index of the industry.

    55

	 * @param cargo_id the index of the cargo.

    56

	 * @pre industry_id has to be valid (use IsValidIndustry()).

    57

	 * @pre cargo_id has to be valid (use IsValidCargo()).

    58

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

    59

	 */

    60

	static int32 GetProduction(IndustryID industry_id, CargoID cargo_id);

    61

    62

	/**

    63

	 * Gets the location of the industry.

    64

	 * @param industry_id the index of the industry.

    65

	 * @pre industry_id has to be valid (use IsValidIndustry()).

    66

	 * @return the location of the industry.

    67

	 * @post return value is always positive and below AIMap::GetMapSize().

    68

	 */

    69

	static TileIndex GetLocation(IndustryID industry_id);

    70

};

    71

    72

#endif /* AI_INDUSTRY_HPP */