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 */ |
4 |
5 |
5 #ifndef AI_INDUSTRYLIST_HPP |
6 #ifndef AI_INDUSTRYLIST_HPP |
6 #define AI_INDUSTRYLIST_HPP |
7 #define AI_INDUSTRYLIST_HPP |
7 |
8 |
8 #include "ai_abstractlist.hpp" |
9 #include "ai_abstractlist.hpp" |
9 |
10 |
10 /** |
11 /** |
11 * Class that creates a list of current industries. |
12 * Creates a list of industries that are currently on the map. |
|
13 * @ingroup AIIndustryList |
12 */ |
14 */ |
13 class AIIndustryList : public AIAbstractList { |
15 class AIIndustryList : public AIAbstractList { |
14 public: |
16 public: |
15 /** |
|
16 * The name of the class, needed by several sub-processes. |
|
17 */ |
|
18 static const char *GetClassName() { return "AIIndustryList"; } |
17 static const char *GetClassName() { return "AIIndustryList"; } |
19 |
|
20 /** |
|
21 * The constructor to make a list of industries. |
|
22 */ |
|
23 AIIndustryList(); |
18 AIIndustryList(); |
24 |
19 |
25 private: |
20 private: |
26 /** |
|
27 * The name of this list, to check if a Valuator can be used on this list. |
|
28 */ |
|
29 const char *GetListName() const { return "AIIndustryList"; } |
21 const char *GetListName() const { return "AIIndustryList"; } |
30 }; |
22 }; |
31 |
23 |
32 /** |
24 /** |
33 * Class that creates a list of industries which accept a given cargo. |
25 * Creates a list of industries that accepts a given cargo. |
|
26 * @ingroup AIIndustryList |
34 */ |
27 */ |
35 class AIIndustryList_CargoAccepting : public AIAbstractList { |
28 class AIIndustryList_CargoAccepting : public AIAbstractList { |
36 public: |
29 public: |
37 /** |
|
38 * The name of the class, needed by several sub-processes. |
|
39 */ |
|
40 static const char *GetClassName() { return "AIIndustryList_CargoAccepting"; } |
30 static const char *GetClassName() { return "AIIndustryList_CargoAccepting"; } |
41 |
31 |
42 /** |
32 /** |
43 * The constructor to make a list of industries which accept a given cargo. |
33 * @param cargo_id The cargo this industry should accept. |
44 * @param cargo_id the cargo this industry should accept. |
|
45 */ |
34 */ |
46 AIIndustryList_CargoAccepting(CargoID cargo_id); |
35 AIIndustryList_CargoAccepting(CargoID cargo_id); |
47 |
36 |
48 private: |
37 private: |
49 /** |
|
50 * The name of this list, to check if a Valuator can be used on this list. |
|
51 */ |
|
52 const char *GetListName() const { return "AIIndustryList"; } |
38 const char *GetListName() const { return "AIIndustryList"; } |
53 }; |
39 }; |
54 |
40 |
55 /** |
41 /** |
56 * Class that creates a list of industries which produces a given cargo. |
42 * Creates a list of industries that produce a given cargo. |
|
43 * @ingroup AIIndustryList |
57 */ |
44 */ |
58 class AIIndustryList_CargoProducing : public AIAbstractList { |
45 class AIIndustryList_CargoProducing : public AIAbstractList { |
59 public: |
46 public: |
60 /** |
|
61 * The name of the class, needed by several sub-processes. |
|
62 */ |
|
63 static const char *GetClassName() { return "AIIndustryList_CargoProducing"; } |
47 static const char *GetClassName() { return "AIIndustryList_CargoProducing"; } |
64 |
48 |
65 /** |
49 /** |
66 * The constructor to make a list of industries which produces a given cargo. |
50 * @param cargo_id The cargo this industry should produce. |
67 * @param cargo_id the cargo this industry should produce. |
|
68 */ |
51 */ |
69 AIIndustryList_CargoProducing(CargoID cargo_id); |
52 AIIndustryList_CargoProducing(CargoID cargo_id); |
70 |
53 |
71 private: |
54 private: |
72 /** |
|
73 * The name of this list, to check if a Valuator can be used on this list. |
|
74 */ |
|
75 const char *GetListName() const { return "AIIndustryList"; } |
55 const char *GetListName() const { return "AIIndustryList"; } |
76 }; |
56 }; |
77 |
57 |
78 #endif /* AI_INDUSTRYLIST_HPP */ |
58 #endif /* AI_INDUSTRYLIST_HPP */ |