OpenTTD NoAI API
Public Types | Public Member Functions | Data Fields | Static Public Attributes
AIList Class Reference

Class that creates a list which can keep item/value pairs, which you can walk. More...

Inheritance diagram for AIList:
AIObject AIBridgeList AIBridgeList_Length AICargoList AICargoList_IndustryAccepting AICargoList_IndustryProducing AIDepotList AIEngineList AIGroupList AIIndustryList AIIndustryList_CargoAccepting AIIndustryList_CargoProducing AIIndustryTypeList AIRailTypeList AISignList AIStationList AIStationList_Vehicle AISubsidyList AITileList AITownList AIVehicleList AIVehicleList_DefaultGroup AIVehicleList_Depot AIVehicleList_Group AIVehicleList_SharedOrders AIVehicleList_Station AIWaypointList AIWaypointList_Vehicle

Public Types

enum  SorterType {
  SORT_BY_VALUE,
  SORT_BY_ITEM
}
 Type of sorter. More...
typedef std::set< int32 > AIItemList
 The list of items inside the bucket.
typedef std::map< int32,
AIItemList
AIListBucket
 The bucket list per value.
typedef std::map< int32, int32 > AIListMap
 List per item.

Public Member Functions

void AddItem (int32 item, int32 value=0)
 Add a single item to the list.
void RemoveItem (int32 item)
 Remove a single item from the list.
void Clear ()
 Clear the list, making Count() returning 0 and IsEmpty() returning true.
bool HasItem (int32 item)
 Check if an item is in the list.
int32 Begin ()
 Go to the beginning of the list.
int32 Next ()
 Go to the next item in the list.
bool IsEmpty ()
 Check if a list is empty.
bool IsEnd ()
 Check if there is a element left.
int32 Count ()
 Returns the amount of items in the list.
int32 GetValue (int32 item)
 Get the value that belongs to this item.
bool SetValue (int32 item, int32 value)
 Set a value of an item directly.
void Sort (SorterType sorter, bool ascending)
 Sort this list by the given sorter and direction.
void AddList (AIList *list)
 Add one list to another one.
void RemoveAboveValue (int32 value)
 Removes all items with a higher value than 'value'.
void RemoveBelowValue (int32 value)
 Removes all items with a lower value than 'value'.
void RemoveBetweenValue (int32 start, int32 end)
 Removes all items with a value above start and below end.
void RemoveValue (int32 value)
 Remove all items with this value.
void RemoveTop (int32 count)
 Remove the first count items.
void RemoveBottom (int32 count)
 Remove the last count items.
void RemoveList (AIList *list)
 Remove everything that is in the given list from this list (same item index that is).
void KeepAboveValue (int32 value)
 Keep all items with a higher value than 'value'.
void KeepBelowValue (int32 value)
 Keep all items with a lower value than 'value'.
void KeepBetweenValue (int32 start, int32 end)
 Keep all items with a value above start and below end.
void KeepValue (int32 value)
 Keep all items with this value.
void KeepTop (int32 count)
 Keep the first count items, i.e.
void KeepBottom (int32 count)
 Keep the last count items, i.e.
void KeepList (AIList *list)
 Keeps everything that is in the given list from this list (same item index that is).
void Valuate (void *valuator_function, int params,...)
 Give all items a value defined by the valuator you give.

Data Fields

AIListMap items
 The items in the list.
AIListBucket buckets
 The items in the list, sorted by value.

Static Public Attributes

static const bool SORT_ASCENDING = true
 Sort ascending.
static const bool SORT_DESCENDING = false
 Sort descnding.

Detailed Description

Class that creates a list which can keep item/value pairs, which you can walk.


Member Enumeration Documentation

Type of sorter.

Enumerator:
SORT_BY_VALUE 

Sort the list based on the value of the item.

SORT_BY_ITEM 

Sort the list based on the item itself.


Member Function Documentation

void AIList::AddItem ( int32  item,
int32  value = 0 
)

Add a single item to the list.

Parameters:
itemthe item to add. Should be unique, otherwise it is ignored.
valuethe value to assign.
Note:
the value is set to 0 by default.
void AIList::AddList ( AIList list)

Add one list to another one.

Parameters:
listThe list that will be added to the caller.
Postcondition:
The list to be added ('list') stays unmodified.
Note:
All added items keep their value as it was in 'list'.
If the item already exists inside the caller, the value of the list that is added is set on the item.
int32 AIList::Begin ( )

Go to the beginning of the list.

Returns:
the item value of the first item.
Note:
returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.
int32 AIList::Count ( )

Returns the amount of items in the list.

Returns:
amount of items in the list.
int32 AIList::GetValue ( int32  item)

Get the value that belongs to this item.

Parameters:
itemthe item to get the value from
Returns:
the value that belongs to this item.
bool AIList::HasItem ( int32  item)

Check if an item is in the list.

Parameters:
itemthe item to check for.
Returns:
true if the item is in the list.
bool AIList::IsEmpty ( )

Check if a list is empty.

Returns:
true if the list is empty.
bool AIList::IsEnd ( )

Check if there is a element left.

In other words, if this is false, the last call to Begin() or Next() returned a valid item.

Returns:
true if the current item is beyond end-of-list.
void AIList::KeepAboveValue ( int32  value)

Keep all items with a higher value than 'value'.

Parameters:
valuethe value above which all items are kept.
void AIList::KeepBelowValue ( int32  value)

Keep all items with a lower value than 'value'.

Parameters:
valuethe value below which all items are kept.
void AIList::KeepBetweenValue ( int32  start,
int32  end 
)

Keep all items with a value above start and below end.

Parameters:
startthe lower bound of the to be kept values (exclusive).
endthe upper bound of the to be kept values (exclusive).
void AIList::KeepBottom ( int32  count)

Keep the last count items, i.e.

remove everything except the last count items.

Parameters:
countthe amount of items to keep.
void AIList::KeepList ( AIList list)

Keeps everything that is in the given list from this list (same item index that is).

Parameters:
listthe list of items to keep.
Precondition:
list != NULL
void AIList::KeepTop ( int32  count)

Keep the first count items, i.e.

remove everything except the first count items.

Parameters:
countthe amount of items to keep.
void AIList::KeepValue ( int32  value)

Keep all items with this value.

Parameters:
valuethe value to keep.
int32 AIList::Next ( )

Go to the next item in the list.

Returns:
the item value of the next item.
Note:
returns 0 if beyond end-of-list. Use IsEnd() to check for end-of-list.
void AIList::RemoveAboveValue ( int32  value)

Removes all items with a higher value than 'value'.

Parameters:
valuethe value above which all items are removed.
void AIList::RemoveBelowValue ( int32  value)

Removes all items with a lower value than 'value'.

Parameters:
valuethe value below which all items are removed.
void AIList::RemoveBetweenValue ( int32  start,
int32  end 
)

Removes all items with a value above start and below end.

Parameters:
startthe lower bound of the to be removed values (exclusive).
endthe upper bound of the to be removed valuens (exclusive).
void AIList::RemoveBottom ( int32  count)

Remove the last count items.

Parameters:
countthe amount of items to remove.
void AIList::RemoveItem ( int32  item)

Remove a single item from the list.

Parameters:
itemthe item to remove. If not existing, it is ignored.
void AIList::RemoveList ( AIList list)

Remove everything that is in the given list from this list (same item index that is).

Parameters:
listthe list of items to remove.
Precondition:
list != NULL
void AIList::RemoveTop ( int32  count)

Remove the first count items.

Parameters:
countthe amount of items to remove.
void AIList::RemoveValue ( int32  value)

Remove all items with this value.

Parameters:
valuethe value to remove.
bool AIList::SetValue ( int32  item,
int32  value 
)

Set a value of an item directly.

Parameters:
itemthe item to set the value for.
valuethe value to give to the item
Returns:
true if we could set the item to value, false otherwise.
Note:
Changing values of items while looping through a list might cause entries to be skipped. Be very careful with such operations.
void AIList::Sort ( SorterType  sorter,
bool  ascending 
)

Sort this list by the given sorter and direction.

Parameters:
sorterthe type of sorter to use
ascendingif true, lowest value is on top, else at bottom.
Note:
the current item stays at the same place.
See also:
SORT_ASCENDING SORT_DESCENDING
void AIList::Valuate ( void *  valuator_function,
int  params,
  ... 
)

Give all items a value defined by the valuator you give.

Parameters:
valuator_functionThe function which will be doing the valuation.
paramsThe params to give to the valuators (minus the first param, which is always the index-value we are valuating).
Note:
You may not add, remove or change (setting the value of) items while valuating. You may also not (re)sort while valuating.
You can write your own valuators and use them. Just remember that the first parameter should be the index-value, and it should return an integer.
Example: list.Valuate(AIBridge.GetPrice, 5); list.Valuate(AIBridge.GetMaxLength); function MyVal(bridge_id, myparam) { return myparam * bridge_id; // This is silly } list.Valuate(MyVal, 12);