refresh.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef REFRESH_H
#define REFRESH_H
 
#include "../cargo_type.h"
#include "../vehicle_base.h"

class LinkRefresher {
public:
  static void Run(Vehicle *v, bool allow_merge = true, bool is_full_loading = false);
 
protected:
  enum class RefreshFlag : uint8_t {
    UseNext,     
    HasCargo,    
    WasRefit,    
    ResetRefit,  
    InAutorefit, 
  };

  using RefreshFlags = EnumBitSet<RefreshFlag, uint8_t>;

  struct RefitDesc {
    CargoType cargo;    
    uint16_t capacity;  
    uint16_t remaining; 
    RefitDesc(CargoType cargo, uint16_t capacity, uint16_t remaining) :
        cargo(cargo), capacity(capacity), remaining(remaining) {}
  };

  struct Hop {
    VehicleOrderID from;  
    VehicleOrderID to;    
    CargoType cargo; 

    Hop() {NOT_REACHED();}

    Hop(VehicleOrderID from, VehicleOrderID to, CargoType cargo) : from(from), to(to), cargo(cargo) {}
 
    constexpr auto operator<=>(const Hop &) const noexcept = default;
  };
 
  typedef std::vector<RefitDesc> RefitList;
  typedef std::set<Hop> HopSet;
 
  Vehicle *vehicle;           
  CargoArray capacities{}; 
  RefitList refit_capacities; 
  HopSet *seen_hops;          
  CargoType cargo;              
  bool allow_merge;           
  bool is_full_loading;       
 
  LinkRefresher(Vehicle *v, HopSet *seen_hops, bool allow_merge, bool is_full_loading);
 
  bool HandleRefit(CargoType refit_cargo);
  void ResetRefit();
  void RefreshStats(VehicleOrderID cur, VehicleOrderID next);
  VehicleOrderID PredictNextOrder(VehicleOrderID cur, VehicleOrderID next, RefreshFlags flags, uint num_hops = 0);
 
  void RefreshLinks(VehicleOrderID cur, VehicleOrderID next, RefreshFlags flags, uint num_hops = 0);
};
 
#endif /* REFRESH_H */