OpenTTD
Public Member Functions | Private Member Functions | Private Attributes | Friends
OrderList Struct Reference

Shared order list linking together the linked list of orders and the list of vehicles sharing this order list. More...

#include <order_base.h>

Inheritance diagram for OrderList:
Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_orderlist_pool >

Public Member Functions

 OrderList (VehicleOrderID num_orders=INVALID_VEH_ORDER_ID)
 Default constructor producing an invalid order list. More...
 
 OrderList (Order *chain, Vehicle *v)
 Create an order list with the given order chain for the given vehicle. More...
 
 ~OrderList ()
 Destructor. More...
 
void Initialize (Order *chain, Vehicle *v)
 Recomputes everything. More...
 
OrderGetFirstOrder () const
 Get the first order of the order chain. More...
 
OrderGetOrderAt (int index) const
 Get a certain order of the order chain. More...
 
OrderGetLastOrder () const
 Get the last order of the order chain. More...
 
const OrderGetNext (const Order *curr) const
 Get the order after the given one or the first one, if the given one is the last one. More...
 
VehicleOrderID GetNumOrders () const
 Get number of orders in the order list. More...
 
VehicleOrderID GetNumManualOrders () const
 Get number of manually added orders in the order list. More...
 
StationIDStack GetNextStoppingStation (const Vehicle *v, const Order *first=NULL, uint hops=0) const
 Recursively determine the next deterministic station to stop at. More...
 
const OrderGetNextDecisionNode (const Order *next, uint hops) const
 Get the next order which will make the given vehicle stop at a station or refit at a depot or evaluate a non-trivial condition. More...
 
void InsertOrderAt (Order *new_order, int index)
 Insert a new order into the order chain. More...
 
void DeleteOrderAt (int index)
 Remove an order from the order list and delete it. More...
 
void MoveOrder (int from, int to)
 Move an order to another position within the order list. More...
 
bool IsShared () const
 Is this a shared order list? More...
 
VehicleGetFirstSharedVehicle () const
 Get the first vehicle of this vehicle chain. More...
 
uint GetNumVehicles () const
 Return the number of vehicles that share this orders list. More...
 
bool IsVehicleInSharedOrdersList (const Vehicle *v) const
 Checks whether a vehicle is part of the shared vehicle chain. More...
 
int GetPositionInSharedOrderList (const Vehicle *v) const
 Gets the position of the given vehicle within the shared order vehicle list. More...
 
void AddVehicle (Vehicle *v)
 Adds the given vehicle to this shared order list. More...
 
void RemoveVehicle (Vehicle *v)
 Removes the vehicle from the shared order list. More...
 
bool IsCompleteTimetable () const
 Checks whether all orders of the list have a filled timetable. More...
 
Ticks GetTimetableTotalDuration () const
 Gets the total duration of the vehicles timetable or INVALID_TICKS is the timetable is not complete. More...
 
Ticks GetTimetableDurationIncomplete () const
 Gets the known duration of the vehicles timetable even if the timetable is not complete. More...
 
Ticks GetTotalDuration () const
 Gets the known duration of the vehicles orders, timetabled or not. More...
 
void UpdateTimetableDuration (Ticks delta)
 Must be called if an order's timetable is changed to update internal book keeping. More...
 
void UpdateTotalDuration (Ticks delta)
 Must be called if an order's timetable is changed to update internal book keeping. More...
 
void FreeChain (bool keep_orderlist=false)
 Free a complete order chain. More...
 
void DebugCheckSanity () const
 Checks for internal consistency of order list. More...
 
- Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_orderlist_pool >
void * operator new (size_t size)
 Allocates space for new Titem. More...
 
void * operator new (size_t size, size_t index)
 Allocates space for new Titem with given index. More...
 
void * operator new (size_t size, void *ptr)
 Allocates space for new Titem at given memory address. More...
 
void operator delete (void *p)
 Marks Titem as free. More...
 

Private Member Functions

StationID GetBestLoadableNext (const Vehicle *v, const Order *o1, const Order *o2) const
 

Private Attributes

Orderfirst
 First order of the order list.
 
VehicleOrderID num_orders
 NOSAVE: How many orders there are in the list.
 
VehicleOrderID num_manual_orders
 NOSAVE: How many manually added orders are there in the list.
 
uint num_vehicles
 NOSAVE: Number of vehicles that share this order list.
 
Vehiclefirst_shared
 NOSAVE: pointer to the first vehicle in the shared order chain.
 
Ticks timetable_duration
 NOSAVE: Total timetabled duration of the order list.
 
Ticks total_duration
 NOSAVE: Total (timetabled or not) duration of the order list.
 

Friends

void AfterLoadVehicles (bool part_of_load)
 For instantiating the shared vehicle chain.
 
const struct SaveLoadGetOrderListDescription ()
 Saving and loading of order lists.
 

Additional Inherited Members

- Static Public Member Functions inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_orderlist_pool >
static bool CanAllocateItem (size_t n=1)
 Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function() More...
 
static bool CleaningPool ()
 Returns current state of pool cleaning - yes or no. More...
 
static bool IsValidID (size_t index)
 Tests whether given index can be used to get valid (non-NULL) Titem. More...
 
static Titem * Get (size_t index)
 Returns Titem with given index. More...
 
static Titem * GetIfValid (size_t index)
 Returns Titem with given index. More...
 
static size_t GetPoolSize ()
 Returns first unused index. More...
 
static size_t GetNumItems ()
 Returns number of valid items in the pool. More...
 
static void PostDestructor (size_t index)
 Dummy function called after destructor of each member. More...
 
- Data Fields inherited from Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_orderlist_pool >
Tindex index
 Index of this pool item.
 

Detailed Description

Shared order list linking together the linked list of orders and the list of vehicles sharing this order list.

Definition at line 252 of file order_base.h.

Constructor & Destructor Documentation

◆ OrderList() [1/2]

OrderList::OrderList ( VehicleOrderID  num_orders = INVALID_VEH_ORDER_ID)
inline

Default constructor producing an invalid order list.

Definition at line 270 of file order_base.h.

◆ OrderList() [2/2]

OrderList::OrderList ( Order chain,
Vehicle v 
)
inline

Create an order list with the given order chain for the given vehicle.

Parameters
chainpointer to the first order of the order chain
vany vehicle using this orderlist

Definition at line 279 of file order_base.h.

◆ ~OrderList()

OrderList::~OrderList ( )
inline

Destructor.

Invalidates OrderList for re-usage by the pool.

Definition at line 282 of file order_base.h.

Member Function Documentation

◆ AddVehicle()

void OrderList::AddVehicle ( Vehicle v)
inline

Adds the given vehicle to this shared order list.

Note
This is supposed to be called after the vehicle has been inserted into the shared vehicle chain.
Parameters
vvehicle to add to the list

Definition at line 354 of file order_base.h.

◆ DebugCheckSanity()

void OrderList::DebugCheckSanity ( ) const

Checks for internal consistency of order list.

Triggers assertion if something is wrong.

Definition at line 605 of file order_cmd.cpp.

References DEBUG, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_order_pool >::index, and Order::next.

◆ DeleteOrderAt()

void OrderList::DeleteOrderAt ( int  index)

Remove an order from the order list and delete it.

Parameters
indexis the position of the order which is to be deleted.

Definition at line 499 of file order_cmd.cpp.

References Order::IsType(), and Order::next.

Referenced by DeleteOrder().

◆ FreeChain()

void OrderList::FreeChain ( bool  keep_orderlist = false)

Free a complete order chain.

Parameters
keep_orderlistIf this is true only delete the orders, otherwise also delete the OrderList.
Note
do not use on "current_order" vehicle orders!

Definition at line 323 of file order_cmd.cpp.

References Order::next.

Referenced by DeleteVehicleOrders().

◆ GetFirstOrder()

Order* OrderList::GetFirstOrder ( ) const
inline

Get the first order of the order chain.

Returns
the first order of the chain.

Definition at line 290 of file order_base.h.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_order_pool >::index.

◆ GetFirstSharedVehicle()

Vehicle* OrderList::GetFirstSharedVehicle ( ) const
inline

Get the first vehicle of this vehicle chain.

Returns
the first vehicle of the chain.

Definition at line 337 of file order_base.h.

Referenced by CmdSetTimetableStart().

◆ GetLastOrder()

Order* OrderList::GetLastOrder ( ) const
inline

Get the last order of the order chain.

Returns
the last order of the chain.

Definition at line 298 of file order_base.h.

◆ GetNext()

const Order* OrderList::GetNext ( const Order curr) const
inline

Get the order after the given one or the first one, if the given one is the last one.

Parameters
currOrder to find the next one for.
Returns
Next order.

Definition at line 306 of file order_base.h.

References Order::next.

◆ GetNextDecisionNode()

const Order * OrderList::GetNextDecisionNode ( const Order next,
uint  hops 
) const

Get the next order which will make the given vehicle stop at a station or refit at a depot or evaluate a non-trivial condition.

Parameters
nextThe order to start looking at.
hopsThe number of orders we have already looked at.
Returns
Either of
  • a station order
  • a refitting depot order
  • a non-trivial conditional order
  • NULL if the vehicle won't stop anymore.

Definition at line 369 of file order_cmd.cpp.

References Order::IsType().

Referenced by LinkRefresher::Run().

◆ GetNextStoppingStation()

StationIDStack OrderList::GetNextStoppingStation ( const Vehicle v,
const Order first = NULL,
uint  hops = 0 
) const

Recursively determine the next deterministic station to stop at.

Parameters
vThe vehicle we're looking at.
firstOrder to start searching at or NULL to start at cur_implicit_order_index + 1.
hopsNumber of orders we have already looked at.
Returns
Next stoppping station or INVALID_STATION.
Precondition
The vehicle is currently loading and v->last_station_visited is meaningful.
Note
This function may draw a random number. Don't use it from the GUI.

Definition at line 404 of file order_cmd.cpp.

References BaseConsist::cur_implicit_order_index, and Order::next.

◆ GetNumManualOrders()

VehicleOrderID OrderList::GetNumManualOrders ( ) const
inline

Get number of manually added orders in the order list.

Returns
number of manual orders in the chain.

Definition at line 318 of file order_base.h.

References Order::next.

◆ GetNumOrders()

VehicleOrderID OrderList::GetNumOrders ( ) const
inline

Get number of orders in the order list.

Returns
number of orders in the chain.

Definition at line 312 of file order_base.h.

Referenced by CmdSellVehicle().

◆ GetNumVehicles()

uint OrderList::GetNumVehicles ( ) const
inline

Return the number of vehicles that share this orders list.

Returns
the count of vehicles that use this shared orders list

Definition at line 343 of file order_base.h.

◆ GetOrderAt()

Order * OrderList::GetOrderAt ( int  index) const

Get a certain order of the order chain.

Parameters
indexzero-based index of the order within the chain.
Returns
the order at position index.

Definition at line 346 of file order_cmd.cpp.

References Order::next.

◆ GetPositionInSharedOrderList()

int OrderList::GetPositionInSharedOrderList ( const Vehicle v) const

Gets the position of the given vehicle within the shared order vehicle list.

Parameters
vis the vehicle of which to get the position
Returns
position of v within the shared vehicle chain.

Definition at line 581 of file order_cmd.cpp.

References Vehicle::PreviousShared().

◆ GetTimetableDurationIncomplete()

Ticks OrderList::GetTimetableDurationIncomplete ( ) const
inline

Gets the known duration of the vehicles timetable even if the timetable is not complete.

Returns
known timetable duration

Definition at line 370 of file order_base.h.

◆ GetTimetableTotalDuration()

Ticks OrderList::GetTimetableTotalDuration ( ) const
inline

Gets the total duration of the vehicles timetable or INVALID_TICKS is the timetable is not complete.

Returns
total timetable duration or INVALID_TICKS for incomplete timetables

Definition at line 364 of file order_base.h.

References INVALID_TICKS.

Referenced by CmdSetTimetableStart().

◆ GetTotalDuration()

Ticks OrderList::GetTotalDuration ( ) const
inline

Gets the known duration of the vehicles orders, timetabled or not.

Returns
known order duration.

Definition at line 376 of file order_base.h.

◆ Initialize()

void OrderList::Initialize ( Order chain,
Vehicle v 
)

Recomputes everything.

Parameters
chainfirst order in the chain
vone of vehicle that is using this orderlist

Definition at line 292 of file order_cmd.cpp.

References Order::next.

◆ InsertOrderAt()

void OrderList::InsertOrderAt ( Order new_order,
int  index 
)

Insert a new order into the order chain.

Parameters
new_orderis the order to insert into the chain.
indexis the position where the order is supposed to be inserted.

Definition at line 461 of file order_cmd.cpp.

References Order::IsType(), and Order::next.

Referenced by InsertOrder().

◆ IsCompleteTimetable()

bool OrderList::IsCompleteTimetable ( ) const

Checks whether all orders of the list have a filled timetable.

Returns
whether all orders have a filled timetable.

Definition at line 592 of file order_cmd.cpp.

References Order::next.

Referenced by CmdSetTimetableStart().

◆ IsShared()

bool OrderList::IsShared ( ) const
inline

Is this a shared order list?

Returns
whether this order list is shared among multiple vehicles

Definition at line 331 of file order_base.h.

Referenced by CmdSellVehicle().

◆ IsVehicleInSharedOrdersList()

bool OrderList::IsVehicleInSharedOrdersList ( const Vehicle v) const

Checks whether a vehicle is part of the shared vehicle chain.

Parameters
vis the vehicle to search in the shared vehicle chain.

Definition at line 567 of file order_cmd.cpp.

References Vehicle::NextShared().

◆ MoveOrder()

void OrderList::MoveOrder ( int  from,
int  to 
)

Move an order to another position within the order list.

Parameters
fromis the zero-based position of the order to move.
tois the zero-based position where the order is moved to.

Definition at line 525 of file order_cmd.cpp.

References Order::next.

Referenced by CmdMoveOrder().

◆ RemoveVehicle()

void OrderList::RemoveVehicle ( Vehicle v)

Removes the vehicle from the shared order list.

Note
This is supposed to be called when the vehicle is still in the chain
Parameters
vvehicle to remove from the list

Definition at line 557 of file order_cmd.cpp.

References Vehicle::NextShared().

◆ UpdateTimetableDuration()

void OrderList::UpdateTimetableDuration ( Ticks  delta)
inline

Must be called if an order's timetable is changed to update internal book keeping.

Parameters
deltaBy how many ticks has the timetable duration changed

Definition at line 382 of file order_base.h.

◆ UpdateTotalDuration()

void OrderList::UpdateTotalDuration ( Ticks  delta)
inline

Must be called if an order's timetable is changed to update internal book keeping.

Parameters
deltaBy how many ticks has the total duration changed

Definition at line 388 of file order_base.h.


The documentation for this struct was generated from the following files: