/* $Id$ */

/** @file ai_industry.hpp Everything to query about industries */

#ifndef AI_INDUSTRY_HPP
#define AI_INDUSTRY_HPP

#include "ai_object.hpp"

/**
 * Class that handles all industry related functions.
 */
class AIIndustry : public AIObject {
public:
	/**
	 * The name of the class, needed by several sub-processes.
	 */
	static const char *GetClassName() { return "AIIndustry"; }

	/**
	 * Gets the maximum industry index; there are no valid industries with a
	 *   higher index.
	 * @return the maximum industry index.
	 * @post return value is always non-negative.
	 */
	IndustryID GetMaxIndustryID();

	/**
	 * Gets the number of industries. This is different than GetMaxIndustryID()
	 *   because of the way OpenTTD works internally.
	 * @return the number of industries.
	 * @post return value is always non-negative.
	 */
	int32 GetIndustryCount();

	/**
	 * Checks whether the given industry index is valid.
	 * @param industry_id the index to check.
	 * @return true if and only if the industry is valid.
	 */
	static bool IsValidIndustry(IndustryID industry_id);

	/**
	 * Get the name of the industry.
	 * @param industry_id the industry to get the name of.
	 * @pre industry_id has to be valid (use IsValidIndustry()).
	 * @return the name of the industry.
	 * @note the returned name must be free'd (C++ only).
	 */
	char *GetName(IndustryID industry_id);

	/**
	 * Gets the production of a cargo of the industry.
	 * @param industry_id the index of the industry.
	 * @param cargo_id the index of the cargo.
	 * @pre industry_id has to be valid (use IsValidIndustry()).
	 * @pre cargo_id has to be valid (use IsValidCargo()).
	 * @return the production of the cargo for this industry.
	 */
	static int32 GetProduction(IndustryID industry_id, CargoID cargo_id);

	/**
	 * Gets the location of the industry.
	 * @param industry_id the index of the industry.
	 * @pre industry_id has to be valid (use IsValidIndustry()).
	 * @return the location of the industry.
	 * @post return value is always positive and below AIMap::GetMapSize().
	 */
	static TileIndex GetLocation(IndustryID industry_id);
};

#endif /* AI_INDUSTRY_HPP */