order_base.h

Go to the documentation of this file.
00001 /* $Id$ */
00002 
00003 /*
00004  * This file is part of OpenTTD.
00005  * 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.
00006  * 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.
00007  * 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/>.
00008  */
00009 
00012 #ifndef ORDER_BASE_H
00013 #define ORDER_BASE_H
00014 
00015 #include "order_type.h"
00016 #include "core/pool_type.hpp"
00017 #include "core/bitmath_func.hpp"
00018 #include "cargo_type.h"
00019 #include "depot_type.h"
00020 #include "station_type.h"
00021 #include "vehicle_type.h"
00022 #include "date_type.h"
00023 
00024 typedef Pool<Order, OrderID, 256, 64000> OrderPool;
00025 typedef Pool<OrderList, OrderListID, 128, 64000> OrderListPool;
00026 extern OrderPool _order_pool;
00027 extern OrderListPool _orderlist_pool;
00028 
00029 /* If you change this, keep in mind that it is saved on 3 places:
00030  * - Load_ORDR, all the global orders
00031  * - Vehicle -> current_order
00032  * - REF_ORDER (all REFs are currently limited to 16 bits!!)
00033  */
00034 struct Order : OrderPool::PoolItem<&_order_pool> {
00035 private:
00036   friend const struct SaveLoad *GetVehicleDescription(VehicleType vt); 
00037   friend void Load_VEHS();                                             
00038   friend const struct SaveLoad *GetOrderDescription();                 
00039 
00040   uint8 type;           
00041   uint8 flags;          
00042   DestinationID dest;   
00043 
00044   CargoID refit_cargo;  
00045   byte refit_subtype;   
00046 
00047 public:
00048   Order *next;          
00049 
00050   uint16 wait_time;    
00051   uint16 travel_time;  
00052 
00053   Order() : refit_cargo(CT_NO_REFIT) {}
00054   ~Order();
00055 
00056   Order(uint32 packed);
00057 
00063   inline bool IsType(OrderType type) const { return this->GetType() == type; }
00064 
00069   inline OrderType GetType() const { return (OrderType)GB(this->type, 0, 4); }
00070 
00071   void Free();
00072 
00073   void MakeGoToStation(StationID destination);
00074   void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type = ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action = ODATF_SERVICE_ONLY, CargoID cargo = CT_NO_REFIT, byte subtype = 0);
00075   void MakeGoToWaypoint(StationID destination);
00076   void MakeLoading(bool ordered);
00077   void MakeLeaveStation();
00078   void MakeDummy();
00079   void MakeConditional(VehicleOrderID order);
00080   void MakeImplicit(StationID destination);
00081 
00086   inline bool IsGotoOrder() const
00087   {
00088     return IsType(OT_GOTO_WAYPOINT) || IsType(OT_GOTO_DEPOT) || IsType(OT_GOTO_STATION);
00089   }
00090 
00096   inline DestinationID GetDestination() const { return this->dest; }
00097 
00103   inline void SetDestination(DestinationID destination) { this->dest = destination; }
00104 
00110   inline bool IsRefit() const { return this->refit_cargo < NUM_CARGO || this->refit_cargo == CT_AUTO_REFIT; }
00111 
00117   inline bool IsAutoRefit() const { return this->refit_cargo == CT_AUTO_REFIT; }
00118 
00124   inline CargoID GetRefitCargo() const { return this->refit_cargo; }
00125 
00131   inline byte GetRefitSubtype() const { return this->refit_subtype; }
00132 
00133   void SetRefit(CargoID cargo, byte subtype = 0);
00134 
00136   inline OrderLoadFlags GetLoadType() const { return (OrderLoadFlags)GB(this->flags, 4, 4); }
00138   inline OrderUnloadFlags GetUnloadType() const { return (OrderUnloadFlags)GB(this->flags, 0, 4); }
00140   inline OrderNonStopFlags GetNonStopType() const { return (OrderNonStopFlags)GB(this->type, 6, 2); }
00142   inline OrderStopLocation GetStopLocation() const { return (OrderStopLocation)GB(this->type, 4, 2); }
00144   inline OrderDepotTypeFlags GetDepotOrderType() const { return (OrderDepotTypeFlags)GB(this->flags, 0, 4); }
00146   inline OrderDepotActionFlags GetDepotActionType() const { return (OrderDepotActionFlags)GB(this->flags, 4, 4); }
00148   inline OrderConditionVariable GetConditionVariable() const { return (OrderConditionVariable)GB(this->dest, 11, 5); }
00150   inline OrderConditionComparator GetConditionComparator() const { return (OrderConditionComparator)GB(this->type, 5, 3); }
00152   inline VehicleOrderID GetConditionSkipToOrder() const { return this->flags; }
00154   inline uint16 GetConditionValue() const { return GB(this->dest, 0, 11); }
00155 
00157   inline void SetLoadType(OrderLoadFlags load_type) { SB(this->flags, 4, 4, load_type); }
00159   inline void SetUnloadType(OrderUnloadFlags unload_type) { SB(this->flags, 0, 4, unload_type); }
00161   inline void SetNonStopType(OrderNonStopFlags non_stop_type) { SB(this->type, 6, 2, non_stop_type); }
00163   inline void SetStopLocation(OrderStopLocation stop_location) { SB(this->type, 4, 2, stop_location); }
00165   inline void SetDepotOrderType(OrderDepotTypeFlags depot_order_type) { SB(this->flags, 0, 4, depot_order_type); }
00167   inline void SetDepotActionType(OrderDepotActionFlags depot_service_type) { SB(this->flags, 4, 4, depot_service_type); }
00169   inline void SetConditionVariable(OrderConditionVariable condition_variable) { SB(this->dest, 11, 5, condition_variable); }
00171   inline void SetConditionComparator(OrderConditionComparator condition_comparator) { SB(this->type, 5, 3, condition_comparator); }
00173   inline void SetConditionSkipToOrder(VehicleOrderID order_id) { this->flags = order_id; }
00175   inline void SetConditionValue(uint16 value) { SB(this->dest, 0, 11, value); }
00176 
00177   bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
00178   bool CanLoadOrUnload() const;
00179   bool CanLeaveWithCargo(bool has_cargo) const;
00180 
00181   TileIndex GetLocation(const Vehicle *v, bool airport = false) const;
00182 
00184   inline bool IsCompletelyTimetabled() const
00185   {
00186     if (this->travel_time == 0 && !this->IsType(OT_CONDITIONAL)) return false;
00187     if (this->wait_time == 0 && this->IsType(OT_GOTO_STATION) && !(this->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) return false;
00188     return true;
00189   }
00190 
00191   void AssignOrder(const Order &other);
00192   bool Equals(const Order &other) const;
00193 
00194   uint32 Pack() const;
00195   uint16 MapOldOrder() const;
00196   void ConvertFromOldSavegame();
00197 };
00198 
00199 void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord);
00200 void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord);
00201 
00206 struct OrderList : OrderListPool::PoolItem<&_orderlist_pool> {
00207 private:
00208   friend void AfterLoadVehicles(bool part_of_load); 
00209   friend const struct SaveLoad *GetOrderListDescription(); 
00210 
00211   const Order *GetBestLoadableNext(const Vehicle *v, const Order *o1, const Order *o2) const;
00212 
00213   Order *first;                     
00214   VehicleOrderID num_orders;        
00215   VehicleOrderID num_manual_orders; 
00216   uint num_vehicles;                
00217   Vehicle *first_shared;            
00218 
00219   Ticks timetable_duration;         
00220 
00221 public:
00223   OrderList(VehicleOrderID num_orders = INVALID_VEH_ORDER_ID)
00224     : first(NULL), num_orders(num_orders), num_manual_orders(0), num_vehicles(0), first_shared(NULL),
00225       timetable_duration(0) { }
00226 
00232   OrderList(Order *chain, Vehicle *v) { this->Initialize(chain, v); }
00233 
00235   ~OrderList() {}
00236 
00237   void Initialize(Order *chain, Vehicle *v);
00238 
00243   inline Order *GetFirstOrder() const { return this->first; }
00244 
00245   Order *GetOrderAt(int index) const;
00246 
00251   inline Order *GetLastOrder() const { return this->GetOrderAt(this->num_orders - 1); }
00252 
00259   inline const Order *GetNext(const Order *curr) const { return (curr->next == NULL) ? this->GetFirstOrder() : curr->next; }
00260 
00265   inline VehicleOrderID GetNumOrders() const { return this->num_orders; }
00266 
00271   inline VehicleOrderID GetNumManualOrders() const { return this->num_manual_orders; }
00272 
00273   StationID GetNextStoppingStation(const Vehicle *v) const;
00274   const Order *GetNextStoppingOrder(const Vehicle *v, const Order *next, uint hops, bool is_loading = false) const;
00275 
00276   void InsertOrderAt(Order *new_order, int index);
00277   void DeleteOrderAt(int index);
00278   void MoveOrder(int from, int to);
00279 
00284   inline bool IsShared() const { return this->num_vehicles > 1; };
00285 
00290   inline Vehicle *GetFirstSharedVehicle() const { return this->first_shared; }
00291 
00296   inline uint GetNumVehicles() const { return this->num_vehicles; }
00297 
00298   bool IsVehicleInSharedOrdersList(const Vehicle *v) const;
00299   int GetPositionInSharedOrderList(const Vehicle *v) const;
00300 
00307   inline void AddVehicle(Vehicle *v) { ++this->num_vehicles; }
00308 
00309   void RemoveVehicle(Vehicle *v);
00310 
00311   bool IsCompleteTimetable() const;
00312 
00317   inline Ticks GetTimetableTotalDuration() const { return this->IsCompleteTimetable() ? this->timetable_duration : INVALID_TICKS; }
00318 
00323   inline Ticks GetTimetableDurationIncomplete() const { return this->timetable_duration; }
00324 
00329   void UpdateOrderTimetable(Ticks delta) { this->timetable_duration += delta; }
00330 
00331   void FreeChain(bool keep_orderlist = false);
00332 
00333   void DebugCheckSanity() const;
00334 };
00335 
00336 #define FOR_ALL_ORDERS_FROM(var, start) FOR_ALL_ITEMS_FROM(Order, order_index, var, start)
00337 #define FOR_ALL_ORDERS(var) FOR_ALL_ORDERS_FROM(var, 0)
00338 
00339 
00340 #define FOR_VEHICLE_ORDERS(v, order) for (order = (v->orders.list == NULL) ? NULL : v->orders.list->GetFirstOrder(); order != NULL; order = order->next)
00341 
00342 
00343 #define FOR_ALL_ORDER_LISTS_FROM(var, start) FOR_ALL_ITEMS_FROM(OrderList, orderlist_index, var, start)
00344 #define FOR_ALL_ORDER_LISTS(var) FOR_ALL_ORDER_LISTS_FROM(var, 0)
00345 
00346 #endif /* ORDER_BASE_H */