src/ai/api/ai_industrylist.hpp
author truebrain
Wed, 27 Feb 2008 21:07:31 +0000
branchnoai
changeset 9792 e1222f4674c2
parent 9778 38560cd27070
child 9797 5bb54b2a6f6f
permissions -rw-r--r--
(svn r12294) [NoAI] -Add: added AIBridge(List), which lists all available bridges (no build yet)
/* $Id$ */

/** @file ai_industrylist.hpp list all the industries */
/** @defgroup AIIndustryList AIIndustryList - Valuators and lists working on/with AIIndustryList */

#ifndef AI_INDUSTRYLIST_HPP
#define AI_INDUSTRYLIST_HPP

#include "ai_abstractlist.hpp"

/**
 * Creates a list of industries that are currently on the map.
 * @ingroup AIIndustryList
 */
class AIIndustryList : public AIAbstractList {
public:
	static const char *GetClassName() { return "AIIndustryList"; }
	AIIndustryList();

private:
	const char *GetListName() const { return "AIIndustryList"; }
};

/**
 * Creates a list of industries that accepts a given cargo.
 * @ingroup AIIndustryList
 */
class AIIndustryList_CargoAccepting : public AIAbstractList {
public:
	static const char *GetClassName() { return "AIIndustryList_CargoAccepting"; }

	/**
	 * @param cargo_id The cargo this industry should accept.
	 */
	AIIndustryList_CargoAccepting(CargoID cargo_id);

private:
	const char *GetListName() const { return "AIIndustryList"; }
};

/**
 * Creates a list of industries that produce a given cargo.
 * @ingroup AIIndustryList
 */
class AIIndustryList_CargoProducing : public AIAbstractList {
public:
	static const char *GetClassName() { return "AIIndustryList_CargoProducing"; }

	/**
	 * @param cargo_id The cargo this industry should produce.
	 */
	AIIndustryList_CargoProducing(CargoID cargo_id);

private:
	const char *GetListName() const { return "AIIndustryList"; }
};

#endif /* AI_INDUSTRYLIST_HPP */