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
00131 inline DestinationID GetDestination() const { return this->dest; }
00132
00138 inline void SetDestination(DestinationID destination) { this->dest = destination; }
00139
00145 inline bool IsRefit() const { return this->refit_cargo < NUM_CARGO; }
00146
00152 inline CargoID GetRefitCargo() const { return this->refit_cargo; }
00153
00159 inline byte GetRefitSubtype() const { return this->refit_subtype; }
00160
00167 void SetRefit(CargoID cargo, byte subtype = 0);
00168
00170 inline OrderLoadFlags GetLoadType() const { return (OrderLoadFlags)GB(this->flags, 4, 4); }
00172 inline OrderUnloadFlags GetUnloadType() const { return (OrderUnloadFlags)GB(this->flags, 0, 4); }
00174 inline OrderNonStopFlags GetNonStopType() const { return (OrderNonStopFlags)GB(this->type, 6, 2); }
00176 inline OrderStopLocation GetStopLocation() const { return (OrderStopLocation)GB(this->type, 4, 2); }
00178 inline OrderDepotTypeFlags GetDepotOrderType() const { return (OrderDepotTypeFlags)GB(this->flags, 0, 4); }
00180 inline OrderDepotActionFlags GetDepotActionType() const { return (OrderDepotActionFlags)GB(this->flags, 4, 4); }
00182 inline OrderConditionVariable GetConditionVariable() const { return (OrderConditionVariable)GB(this->dest, 11, 5); }
00184 inline OrderConditionComparator GetConditionComparator() const { return (OrderConditionComparator)GB(this->type, 5, 3); }
00186 inline VehicleOrderID GetConditionSkipToOrder() const { return this->flags; }
00188 inline uint16 GetConditionValue() const { return GB(this->dest, 0, 11); }
00189
00191 inline void SetLoadType(OrderLoadFlags load_type) { SB(this->flags, 4, 4, load_type); }
00193 inline void SetUnloadType(OrderUnloadFlags unload_type) { SB(this->flags, 0, 4, unload_type); }
00195 inline void SetNonStopType(OrderNonStopFlags non_stop_type) { SB(this->type, 6, 2, non_stop_type); }
00197 inline void SetStopLocation(OrderStopLocation stop_location) { SB(this->type, 4, 2, stop_location); }
00199 inline void SetDepotOrderType(OrderDepotTypeFlags depot_order_type) { SB(this->flags, 0, 4, depot_order_type); }
00201 inline void SetDepotActionType(OrderDepotActionFlags depot_service_type) { SB(this->flags, 4, 4, depot_service_type); }
00203 inline void SetConditionVariable(OrderConditionVariable condition_variable) { SB(this->dest, 11, 5, condition_variable); }
00205 inline void SetConditionComparator(OrderConditionComparator condition_comparator) { SB(this->type, 5, 3, condition_comparator); }
00207 inline void SetConditionSkipToOrder(VehicleOrderID order_id) { this->flags = order_id; }
00209 inline void SetConditionValue(uint16 value) { SB(this->dest, 0, 11, value); }
00210
00211 bool ShouldStopAtStation(const Vehicle *v, StationID station) const;
00212
00214 inline bool IsCompletelyTimetabled() const
00215 {
00216 if (this->travel_time == 0 && !this->IsType(OT_CONDITIONAL)) return false;
00217 if (this->wait_time == 0 && this->IsType(OT_GOTO_STATION) && !(this->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION)) return false;
00218 return true;
00219 }
00220
00225 void AssignOrder(const Order &other);
00226
00232 bool Equals(const Order &other) const;
00233
00240 uint32 Pack() const;
00241
00247 uint16 MapOldOrder() const;
00248
00253 void ConvertFromOldSavegame();
00254 };
00255
00259 struct OrderList : OrderListPool::PoolItem<&_orderlist_pool> {
00260 private:
00261 friend void AfterLoadVehicles(bool part_of_load);
00262 friend const struct SaveLoad *GetOrderListDescription();
00263
00264 Order *first;
00265 VehicleOrderID num_orders;
00266 uint num_vehicles;
00267 Vehicle *first_shared;
00268
00269 Ticks timetable_duration;
00270
00271 public:
00273 OrderList(VehicleOrderID num_orders = INVALID_VEH_ORDER_ID)
00274 : first(NULL), num_orders(num_orders), num_vehicles(0), first_shared(NULL),
00275 timetable_duration(0) { }
00276
00281 OrderList(Order *chain, Vehicle *v) { this->Initialize(chain, v); }
00282
00284 ~OrderList() {}
00285
00291 void Initialize(Order *chain, Vehicle *v);
00292
00297 inline Order *GetFirstOrder() const { return this->first; }
00298
00304 Order *GetOrderAt(int index) const;
00305
00310 inline Order *GetLastOrder() const { return this->GetOrderAt(this->num_orders - 1); }
00311
00315 inline VehicleOrderID GetNumOrders() const { return this->num_orders; }
00316
00321 void InsertOrderAt(Order *new_order, int index);
00322
00327 void DeleteOrderAt(int index);
00328
00333 void MoveOrder(int from, int to);
00334
00339 inline bool IsShared() const { return this->num_vehicles > 1; };
00340
00345 inline Vehicle *GetFirstSharedVehicle() const { return this->first_shared; }
00346
00351 inline uint GetNumVehicles() const { return this->num_vehicles; }
00352
00357 bool IsVehicleInSharedOrdersList(const Vehicle *v) const;
00358
00364 int GetPositionInSharedOrderList(const Vehicle *v) const;
00365
00372 inline void AddVehicle(Vehicle *v) { ++this->num_vehicles; }
00373
00379 void RemoveVehicle(Vehicle *v);
00380
00385 bool IsCompleteTimetable() const;
00386
00391 inline Ticks GetTimetableTotalDuration() const { return this->IsCompleteTimetable() ? this->timetable_duration : INVALID_TICKS; }
00392
00397 inline Ticks GetTimetableDurationIncomplete() const { return this->timetable_duration; }
00398
00403 void UpdateOrderTimetable(Ticks delta) { this->timetable_duration += delta; }
00404
00410 void FreeChain(bool keep_orderlist = false);
00411
00415 void DebugCheckSanity() const;
00416 };
00417
00418 #define FOR_ALL_ORDERS_FROM(var, start) FOR_ALL_ITEMS_FROM(Order, order_index, var, start)
00419 #define FOR_ALL_ORDERS(var) FOR_ALL_ORDERS_FROM(var, 0)
00420
00421
00422 #define FOR_VEHICLE_ORDERS(v, order) for (order = (v->orders.list == NULL) ? NULL : v->orders.list->GetFirstOrder(); order != NULL; order = order->next)
00423
00424
00425 #define FOR_ALL_ORDER_LISTS_FROM(var, start) FOR_ALL_ITEMS_FROM(OrderList, orderlist_index, var, start)
00426 #define FOR_ALL_ORDER_LISTS(var) FOR_ALL_ORDER_LISTS_FROM(var, 0)
00427
00428 #endif