src/group.h

   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
   8 /** @file group.h Base class for groups and group functions. */
   9
  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; ///< Pool of groups.
  23
  24 /** Statistics and caches on the vehicles in a group. */
  25 struct GroupStatistics {
  26         uint16 num_vehicle;                     ///< Number of vehicles.
  27         uint16 *num_engines;                    ///< Caches the number of engines of each type the company owns.
  28
  29         bool autoreplace_defined;               ///< Are any autoreplace rules set?
  30         bool autoreplace_finished;              ///< Have all autoreplacement finished?
  31
  32         uint16 num_profit_vehicle;              ///< Number of vehicles considered for profit statistics;
  33         Money profit_last_year;                 ///< Sum of profits for all vehicles.
  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
  65 enum GroupFlags : uint8 {
  66         GF_REPLACE_PROTECTION,    ///< If set to true, the global autoreplace has no effect on the group
  67         GF_REPLACE_WAGON_REMOVAL, ///< If set, autoreplace will perform wagon removal on vehicles in this group.
  68         GF_END,
  69 };
  70
  71 /** Group data. */
  72 struct Group : GroupPool::PoolItem<&_group_pool> {
  73         std::string name;           ///< Group Name
  74         Owner owner;                ///< Group Owner
  75         VehicleType vehicle_type;   ///< Vehicle type of the group
  76
  77         uint8 flags;                ///< Group flags
  78         Livery livery;              ///< Custom colour scheme for vehicles in this group
  79         GroupStatistics statistics; ///< NOSAVE: Statistics and caches on the vehicles in the group.
  80
  81         bool folded;                ///< NOSAVE: Is this group folded in the group view?
  82
  83         GroupID parent;             ///< Parent group
  84
  85         Group(CompanyID owner = INVALID_COMPANY);
  86 };
  87
  88
  89 static inline bool IsDefaultGroupID(GroupID index)
  90 {
  91         return index == DEFAULT_GROUP;
  92 }
  93
  94 /**
  95  * Checks if a GroupID stands for all vehicles of a company
  96  * @param id_g The GroupID to check
  97  * @return true is id_g is identical to ALL_GROUP
  98  */
  99 static inline bool IsAllGroupID(GroupID id_g)
 100 {
 101         return id_g == ALL_GROUP;
 102 }
 103
 104
 105 uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e);
 106 uint GetGroupNumVehicle(CompanyID company, GroupID id_g, VehicleType type);
 107 uint GetGroupNumProfitVehicle(CompanyID company, GroupID id_g, VehicleType type);
 108 Money GetGroupProfitLastYear(CompanyID company, GroupID id_g, VehicleType type);
 109
 110 void SetTrainGroupID(Train *v, GroupID grp);
 111 void UpdateTrainGroupID(Train *v);
 112 void RemoveVehicleFromGroup(const Vehicle *v);
 113 void RemoveAllGroupsForCompany(const CompanyID company);
 114 bool GroupIsInGroup(GroupID search, GroupID group);
 115
 116 extern GroupID _new_group_id;
 117
 118 #endif /* GROUP_H */