group.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef GROUP_H
#define GROUP_H
 
#include "group_type.h"
#include "core/pool_type.hpp"
#include "company_type.h"
#include "vehicle_type.h"
#include "engine_type.h"
#include "livery.h"
#include <string>
 
typedef Pool<Group, GroupID, 16, 64000> GroupPool;
extern GroupPool _group_pool; 
 
struct GroupStatistics {
  Money profit_last_year;                 
  Money profit_last_year_min_age;         
  uint16 *num_engines;                    
  uint16 num_vehicle;                     
  uint16 num_vehicle_min_age;             
  bool autoreplace_defined;               
  bool autoreplace_finished;              
 
  GroupStatistics();
  ~GroupStatistics();
 
  void Clear();
 
  void ClearProfits()
  {
    this->profit_last_year = 0;
 
    this->num_vehicle_min_age = 0;
    this->profit_last_year_min_age = 0;
  }
 
  void ClearAutoreplace()
  {
    this->autoreplace_defined = false;
    this->autoreplace_finished = false;
  }
 
  static GroupStatistics &Get(CompanyID company, GroupID id_g, VehicleType type);
  static GroupStatistics &Get(const Vehicle *v);
  static GroupStatistics &GetAllGroup(const Vehicle *v);
 
  static void CountVehicle(const Vehicle *v, int delta);
  static void CountEngine(const Vehicle *v, int delta);
  static void AddProfitLastYear(const Vehicle *v);
  static void VehicleReachedMinAge(const Vehicle *v);
 
  static void UpdateProfits();
  static void UpdateAfterLoad();
  static void UpdateAutoreplace(CompanyID company);
};
 
enum GroupFlags : uint8 {
  GF_REPLACE_PROTECTION,    
  GF_REPLACE_WAGON_REMOVAL, 
  GF_END,
};
 
struct Group : GroupPool::PoolItem<&_group_pool> {
  std::string name;           
  Owner owner;                
  VehicleType vehicle_type;   
 
  uint8 flags;                
  Livery livery;              
  GroupStatistics statistics; 
 
  bool folded;                
 
  GroupID parent;             
 
  Group(CompanyID owner = INVALID_COMPANY);
};
 
 
static inline bool IsDefaultGroupID(GroupID index)
{
  return index == DEFAULT_GROUP;
}
 
static inline bool IsAllGroupID(GroupID id_g)
{
  return id_g == ALL_GROUP;
}
 
 
uint GetGroupNumEngines(CompanyID company, GroupID id_g, EngineID id_e);
uint GetGroupNumVehicle(CompanyID company, GroupID id_g, VehicleType type);
uint GetGroupNumVehicleMinAge(CompanyID company, GroupID id_g, VehicleType type);
Money GetGroupProfitLastYearMinAge(CompanyID company, GroupID id_g, VehicleType type);
 
void SetTrainGroupID(Train *v, GroupID grp);
void UpdateTrainGroupID(Train *v);
void RemoveVehicleFromGroup(const Vehicle *v);
void RemoveAllGroupsForCompany(const CompanyID company);
bool GroupIsInGroup(GroupID search, GroupID group);
 
#endif /* GROUP_H */