src/ai/api/ai_industrylist.hpp
branchnoai
changeset 9829 80fbe02a4184
parent 9816 35e866676c00
equal deleted inserted replaced
9828:38be66875b45 9829:80fbe02a4184
     1 /* $Id$ */
     1 /* $Id$ */
     2 
     2 
     3 /** @file ai_industrylist.hpp list all the industries */
     3 /** @file ai_industrylist.hpp List all the industries. */
     4 /** @defgroup AIIndustryList AIIndustryList - Valuators and lists working on/with AIIndustryList */
       
     5 
     4 
     6 #ifndef AI_INDUSTRYLIST_HPP
     5 #ifndef AI_INDUSTRYLIST_HPP
     7 #define AI_INDUSTRYLIST_HPP
     6 #define AI_INDUSTRYLIST_HPP
     8 
     7 
     9 #include "ai_abstractlist.hpp"
     8 #include "ai_abstractlist.hpp"
    10 
     9 
    11 /**
    10 /**
    12  * Creates a list of industries that are currently on the map.
    11  * Creates a list of industries that are currently on the map.
    13  * @ingroup AIIndustryList
    12  * @ingroup AIList
    14  */
    13  */
    15 class AIIndustryList : public AIAbstractList {
    14 class AIIndustryList : public AIAbstractList {
    16 public:
    15 public:
    17 	static const char *GetClassName() { return "AIIndustryList"; }
    16 	static const char *GetClassName() { return "AIIndustryList"; }
    18 	AIIndustryList();
    17 	AIIndustryList();
    19 };
    18 };
    20 
    19 
    21 /**
    20 /**
    22  * Creates a list of industries that accepts a given cargo.
    21  * Creates a list of industries that accepts a given cargo.
    23  * @ingroup AIIndustryList
    22  * @ingroup AIList
    24  */
    23  */
    25 class AIIndustryList_CargoAccepting : public AIAbstractList {
    24 class AIIndustryList_CargoAccepting : public AIAbstractList {
    26 public:
    25 public:
    27 	static const char *GetClassName() { return "AIIndustryList_CargoAccepting"; }
    26 	static const char *GetClassName() { return "AIIndustryList_CargoAccepting"; }
    28 
    27 
    33 };
    32 };
    34 
    33 
    35 /**
    34 /**
    36  * Creates a list of industries that can produce a given cargo.
    35  * Creates a list of industries that can produce a given cargo.
    37  * @note It also contains industries that currently produces 0 units of the cargo.
    36  * @note It also contains industries that currently produces 0 units of the cargo.
    38  * @ingroup AIIndustryList
    37  * @ingroup AIList
    39  */
    38  */
    40 class AIIndustryList_CargoProducing : public AIAbstractList {
    39 class AIIndustryList_CargoProducing : public AIAbstractList {
    41 public:
    40 public:
    42 	static const char *GetClassName() { return "AIIndustryList_CargoProducing"; }
    41 	static const char *GetClassName() { return "AIIndustryList_CargoProducing"; }
    43 
    42