OpenTTD Source: src/group.h Source File

OpenTTD Source 1.11.0-RC1

group.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef GROUP_H
11 #define GROUP_H
12
13 #include "group_type.h"
14 #include "core/pool_type.hpp"
15 #include "company_type.h"
16 #include "vehicle_type.h"
17 #include "engine_type.h"
18 #include "livery.h"
19 #include <string>
20
21 typedef Pool<Group, GroupID, 16, 64000> GroupPool;
22 extern GroupPool _group_pool;
23
25 struct GroupStatistics {
26 uint16 num_vehicle;
27 uint16 *num_engines;
28
29 bool autoreplace_defined;
30 bool autoreplace_finished;
31
32 uint16 num_profit_vehicle;
33 Money profit_last_year;
34
35 GroupStatistics();
36 ~GroupStatistics();
37
38 void Clear();
39
40 void ClearProfits()
41 {
42 this->num_profit_vehicle = 0;
43 this->profit_last_year = 0;
44 }
45
46 void ClearAutoreplace()
47 {
48 this->autoreplace_defined = false;
49 this->autoreplace_finished = false;
50 }
51
52 static GroupStatistics &Get(CompanyID company, GroupID id_g, VehicleType type);
53 static GroupStatistics &Get(const Vehicle *v);
54 static GroupStatistics &GetAllGroup(const Vehicle *v);
55
56 static void CountVehicle(const Vehicle *v, int delta);
57 static void CountEngine(const Vehicle *v, int delta);
58 static void VehicleReachedProfitAge(const Vehicle *v);
59
60 static void UpdateProfits();
61 static void UpdateAfterLoad();
62 static void UpdateAutoreplace(CompanyID company);
63 };
64
66 struct Group : GroupPool::PoolItem<&_group_pool> {
67 std::string name;
68 Owner owner;
69 VehicleType vehicle_type;
70
71 bool replace_protection;
72 Livery livery;
73 GroupStatistics statistics;
74
75 bool folded;
76
77 GroupID parent;
78
79 Group(CompanyID owner = INVALID_COMPANY);
80 };
81
82
83 static inline bool IsDefaultGroupID(GroupID index)
84 {
85 return index == DEFAULT_GROUP;
86 }
87
93 static inline bool IsAllGroupID(GroupID id_g)
94 {
95 return id_g == ALL_GROUP;
96 }
97
98
99 uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e);
100 uint GetGroupNumVehicle(CompanyID company, GroupID id_g, VehicleType type);
101 uint GetGroupNumProfitVehicle(CompanyID company, GroupID id_g, VehicleType type);
102 Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type);
103
104 void SetTrainGroupID(Train *v, GroupID grp);
105 void UpdateTrainGroupID(Train *v);
106 void RemoveVehicleFromGroup(const Vehicle *v);
107 void RemoveAllGroupsForCompany(const CompanyID company);
108 bool GroupIsInGroup(GroupID search, GroupID group);
109
110 extern GroupID _new_group_id;
111
112 #endif /* GROUP_H */
SetTrainGroupID
void SetTrainGroupID(Train *v, GroupID grp)
Affect the groupID of a train to new_g.
Definition: group_cmd.cpp:730
_group_pool
GroupPool _group_pool
Pool of groups.
GroupStatistics::CountEngine
static void CountEngine(const Vehicle *v, int delta)
Update num_engines when adding/removing an engine.
Definition: group_cmd.cpp:156
Group::parent
GroupID parent
Parent group.
Definition: group.h:77
GroupStatistics::CountVehicle
static void CountVehicle(const Vehicle *v, int delta)
Update num_vehicle when adding or removing a vehicle.
Definition: group_cmd.cpp:133
GroupStatistics::autoreplace_finished
bool autoreplace_finished
Have all autoreplacement finished?
Definition: group.h:30
Group::livery
Livery livery
Custom colour scheme for vehicles in this group.
Definition: group.h:72
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:222
GroupStatistics::profit_last_year
Money profit_last_year
Sum of profits for all vehicles.
Definition: group.h:33
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Group::vehicle_type
VehicleType vehicle_type
Vehicle type of the group.
Definition: group.h:69
GroupStatistics::num_vehicle
uint16 num_vehicle
Number of vehicles.
Definition: group.h:26
ALL_GROUP
static const GroupID ALL_GROUP
All vehicles are in this group.
Definition: group_type.h:16
RemoveVehicleFromGroup
void RemoveVehicleFromGroup(const Vehicle *v)
Decrease the num_vehicle variable before delete an front engine from a group.
Definition: group_cmd.cpp:716
Group
Group data.
Definition: group.h:66
Group::replace_protection
bool replace_protection
If set to true, the global autoreplace have no effect on the group.
Definition: group.h:71
GroupStatistics
Statistics and caches on the vehicles in a group.
Definition: group.h:25
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
UpdateTrainGroupID
void UpdateTrainGroupID(Train *v)
Recalculates the groupID of a train.
Definition: group_cmd.cpp:758
Group::statistics
GroupStatistics statistics
NOSAVE: Statistics and caches on the vehicles in the group.
Definition: group.h:73
Group::owner
Owner owner
Group Owner.
Definition: group.h:68
GroupStatistics::UpdateAutoreplace
static void UpdateAutoreplace(CompanyID company)
Update autoreplace_defined and autoreplace_finished of all statistics of a company.
Definition: group_cmd.cpp:204
Train
'Train' is either a loco or a wagon.
Definition: train.h:85
GroupStatistics::Get
static GroupStatistics & Get(CompanyID company, GroupID id_g, VehicleType type)
Returns the GroupStatistics for a specific group.
Definition: group_cmd.cpp:63
DEFAULT_GROUP
static const GroupID DEFAULT_GROUP
Ungrouped vehicles are in this group.
Definition: group_type.h:17
GroupStatistics::num_engines
uint16 * num_engines
Caches the number of engines of each type the company owns.
Definition: group.h:27
GroupStatistics::GetAllGroup
static GroupStatistics & GetAllGroup(const Vehicle *v)
Returns the GroupStatistic for the ALL_GROUPO of a vehicle type.
Definition: group_cmd.cpp:93
GroupStatistics::VehicleReachedProfitAge
static void VehicleReachedProfitAge(const Vehicle *v)
Add a vehicle to the profit sum of its group.
Definition: group_cmd.cpp:166
IsAllGroupID
static bool IsAllGroupID(GroupID id_g)
Checks if a GroupID stands for all vehicles of a company.
Definition: group.h:93
livery.h
VehicleType
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21
GroupStatistics::autoreplace_defined
bool autoreplace_defined
Are any autoreplace rules set?
Definition: group.h:29
GetGroupNumProfitVehicle
uint GetGroupNumProfitVehicle(CompanyID company, GroupID id_g, VehicleType type)
Get the number of vehicles above profit minimum age in the group with GroupID id_g and its sub-groups...
Definition: group_cmd.cpp:819
vehicle_type.h
Pool
Base class for all pools.
Definition: pool_type.hpp:81
GroupID
uint16 GroupID
Type for all group identifiers.
Definition: group_type.h:13
engine_type.h
GroupStatistics::UpdateProfits
static void UpdateProfits()
Recompute the profits for all groups.
Definition: group_cmd.cpp:180
Group::name
std::string name
Group Name.
Definition: group.h:67
GetGroupNumEngines
uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e)
Get the number of engines with EngineID id_e in the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:784
GroupStatistics::Clear
void Clear()
Clear all caches.
Definition: group_cmd.cpp:45
OverflowSafeInt< int64, INT64_MAX, INT64_MIN >
GetGroupNumVehicle
uint GetGroupNumVehicle(CompanyID company, GroupID id_g, VehicleType type)
Get the number of vehicles in the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:802
Group::folded
bool folded
NOSAVE: Is this group folded in the group view?
Definition: group.h:75
INVALID_COMPANY
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
pool_type.hpp
group_type.h
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:226
Livery
Information about a particular livery.
Definition: livery.h:78
company_type.h
GroupStatistics::UpdateAfterLoad
static void UpdateAfterLoad()
Update all caches after loading a game, changing NewGRF, etc.
Definition: group_cmd.cpp:101
GroupStatistics::num_profit_vehicle
uint16 num_profit_vehicle
Number of vehicles considered for profit statistics;.
Definition: group.h:32
GetGroupProfitLastYear
Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type)
Get last year's profit for the group with GroupID id_g and its sub-groups.
Definition: group_cmd.cpp:836
GroupIsInGroup
bool GroupIsInGroup(GroupID search, GroupID group)
Test if GroupID group is a descendant of (or is) GroupID search.
Definition: group_cmd.cpp:859