00001
00002
00003
00004
00005
00006
00007
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
00030
00031
00032
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
00060 Order(uint32 packed);
00061
00067 inline bool IsType(OrderType type) const { return this->GetType() == type; }
00068
00073 inline OrderType GetType() const { return (OrderType)GB(this->type, 0, 4); }
00074
00079 void Free();
00080
00085 void MakeGoToStation(StationID destination);
00086
00096 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);
00097
00102 void MakeGoToWaypoint(StationID destination);
00103
00108 void MakeLoading(bool ordered);
00109
00113 void MakeLeaveStation();
00114
00118 void MakeDummy();
00119
00124 void MakeConditional(VehicleOrderID order);
00125
00130 void MakeAutomatic(StationID destination);
00131
00137 inline DestinationID GetDestination() const { return this->dest; }
00138
00144 inline void SetDestination(DestinationID destination) { this->dest = destination; }
00145
00151 inline bool IsRefit() const { return this->refit_cargo < NUM_CARGO; }
00152
00158 inline CargoID GetRefitCargo() const { return this->refit_cargo; }
00159
00165 inline byte GetRefitSubtype() const { return this->refit_subtype; }
00166
00173 void SetRefit(CargoID cargo, byte subtype = 0);
00174
00176 inline OrderLoadFlags GetLoadType() const { return (OrderLoadFlags)GB(this->flags, 4, 4); }
00178 inline OrderUnloadFlags GetUnloadType() const { return (OrderUnloadFlags)GB(this->flags, 0, 4); }
00180 inline OrderNonStopFlags GetNonStopType() const { return (OrderNonStopFlags)GB(this->type, 6, 2); }
00182 inline OrderStopLocation GetStopLocation() const { return (OrderStopLocation)GB(this->type, 4, 2); }
00184 inline OrderDepotTypeFlags GetDepotOrderType() const { return (OrderDepotTypeFlags)GB(this->flags, 0, 4); }
00186 inline OrderDepotActionFlags GetDepotActionType() const { return (OrderDepotActionFlags)GB(this->flags, 4, 4); }
00188 inline OrderConditionVariable GetConditionVariable() const { return (OrderConditionVariable)GB(this->dest, 11, 5); }
00190 inline OrderConditionComparator GetConditionComparator() const { return (OrderConditionComparator)GB(this->type, 5, 3); }
00192 inline VehicleOrderID GetConditionSkipToOrder() const { return this->flags; }
00194 inline uint16 GetConditionValue() const { return GB(this->dest, 0, 11); }
00195
00197 inline void SetLoadType(OrderLoadFlags load_type) { SB(this->flags, 4, 4, load_type); }
00199 inline void SetUnloadType(OrderUnloadFlags unload_type) { SB(this->flags, 0, 4, unload_type); }
00201 inline void SetNonStopType(OrderNonStopFlags non_stop_type) { SB(this->type, 6, 2, non_stop_type); }
00203 inline void SetStopLocation(OrderStopLocation stop_location) { SB(this->type, 4, 2, stop_location); }
00205 inline void SetDepotOrderType(OrderDepotTypeFlags depot_order_type) { SB(this->flags, 0, 4, depot_order_type); }
00207 inline void SetDepotActionType(OrderDepotActionFlags depot_service_type) { SB(this->flags, 4, 4, depot_service_type); }
00209 inline void SetConditionVariable(OrderConditionVariable condition_variable) { SB(this->dest, 11, 5, condition_variable); }
00211 inline void SetConditionComparator(OrderConditionComparator condition_comparator) { SB(this->type, 5, 3, condition_comparator); }
00213 inline void SetConditionSkipToOrder(VehicleOrderID order_id) { this->flags = order_id; }
00215 inline void SetConditionValue(uint16 value) { SB(this->dest, 0, 11, value); }
00216
00217 bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
00218 TileIndex GetLocation(const Vehicle *v) const;
00219
00221 inline bool IsCompletelyTimetabled() const
00222 {
00223 if (this->travel_time == 0 && !this->IsType(OT_CONDITIONAL)) return false;
00224 if (this->wait_time == 0 && this->IsType(OT_GOTO_STATION) && !(this->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) return false;
00225 return true;
00226 }
00227
00232 void AssignOrder(const Order &other);
00233
00239 bool Equals(const Order &other) const;
00240
00247 uint32 Pack() const;
00248
00254 uint16 MapOldOrder() const;
00255
00260 void ConvertFromOldSavegame();
00261 };
00262
00263 void InsertOrder(Vehicle *v, Order *new_o, VehicleOrderID sel_ord);
00264 void DeleteOrder(Vehicle *v, VehicleOrderID sel_ord);
00265
00270 struct OrderList : OrderListPool::PoolItem<&_orderlist_pool> {
00271 private:
00272 friend void AfterLoadVehicles(bool part_of_load);
00273 friend const struct SaveLoad *GetOrderListDescription();
00274
00275 Order *first;
00276 VehicleOrderID num_orders;
00277 VehicleOrderID num_manual_orders;
00278 uint num_vehicles;
00279 Vehicle *first_shared;
00280
00281 Ticks timetable_duration;
00282
00283 public:
00285 OrderList(VehicleOrderID num_orders = INVALID_VEH_ORDER_ID)
00286 : first(NULL), num_orders(num_orders), num_manual_orders(0), num_vehicles(0), first_shared(NULL),
00287 timetable_duration(0) { }
00288
00294 OrderList(Order *chain, Vehicle *v) { this->Initialize(chain, v); }
00295
00297 ~OrderList() {}
00298
00304 void Initialize(Order *chain, Vehicle *v);
00305
00310 inline Order *GetFirstOrder() const { return this->first; }
00311
00317 Order *GetOrderAt(int index) const;
00318
00323 inline Order *GetLastOrder() const { return this->GetOrderAt(this->num_orders - 1); }
00324
00329 inline VehicleOrderID GetNumOrders() const { return this->num_orders; }
00330
00335 inline VehicleOrderID GetNumManualOrders() const { return this->num_manual_orders; }
00336
00342 void InsertOrderAt(Order *new_order, int index);
00343
00348 void DeleteOrderAt(int index);
00349
00355 void MoveOrder(int from, int to);
00356
00361 inline bool IsShared() const { return this->num_vehicles > 1; };
00362
00367 inline Vehicle *GetFirstSharedVehicle() const { return this->first_shared; }
00368
00373 inline uint GetNumVehicles() const { return this->num_vehicles; }
00374
00379 bool IsVehicleInSharedOrdersList(const Vehicle *v) const;
00380
00386 int GetPositionInSharedOrderList(const Vehicle *v) const;
00387
00394 inline void AddVehicle(Vehicle *v) { ++this->num_vehicles; }
00395
00401 void RemoveVehicle(Vehicle *v);
00402
00407 bool IsCompleteTimetable() const;
00408
00413 inline Ticks GetTimetableTotalDuration() const { return this->IsCompleteTimetable() ? this->timetable_duration : INVALID_TICKS; }
00414
00419 inline Ticks GetTimetableDurationIncomplete() const { return this->timetable_duration; }
00420
00425 void UpdateOrderTimetable(Ticks delta) { this->timetable_duration += delta; }
00426
00432 void FreeChain(bool keep_orderlist = false);
00433
00437 void DebugCheckSanity() const;
00438 };
00439
00440 #define FOR_ALL_ORDERS_FROM(var, start) FOR_ALL_ITEMS_FROM(Order, order_index, var, start)
00441 #define FOR_ALL_ORDERS(var) FOR_ALL_ORDERS_FROM(var, 0)
00442
00443
00444 #define FOR_VEHICLE_ORDERS(v, order) for (order = (v->orders.list == NULL) ? NULL : v->orders.list->GetFirstOrder(); order != NULL; order = order->next)
00445
00446
00447 #define FOR_ALL_ORDER_LISTS_FROM(var, start) FOR_ALL_ITEMS_FROM(OrderList, orderlist_index, var, start)
00448 #define FOR_ALL_ORDER_LISTS(var) FOR_ALL_ORDER_LISTS_FROM(var, 0)
00449
00450 #endif