Class that creates a list which can keep item/value pairs, which you can walk. More...
#include <ai_abstractlist.hpp>
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 > | AIAbstractListBucket |
The bucket list per value. | |
typedef std::map< int32, int32 > | AIAbstractListMap |
List per item. | |
Public Member Functions | |
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 | HasNext () |
Check if there is a next element. | |
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 (AIAbstractList *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 (AIAbstractList *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 (AIAbstractList *list) |
Keeps everything that is in the given list from this list (same item index that is). | |
SQInteger | _get (HSQUIRRELVM vm) |
Used for 'foreach()' and [] get from Squirrel. | |
SQInteger | _nexti (HSQUIRRELVM vm) |
Used for 'foreach()' from Squirrel. | |
SQInteger | Valuate (HSQUIRRELVM vm) |
The Valuate() wrapper from Squirrel. | |
Static Public Member Functions | |
static const char * | GetClassName () |
Data Fields | |
AIAbstractListMap | items |
The items in the list. | |
AIAbstractListBucket | 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. | |
Protected Member Functions | |
void | AddItem (int32 item) |
Add a single item to the list. | |
void | RemoveItem (int32 item) |
Remove a single item from the list. | |
Private Attributes | |
AIAbstractListSorter * | sorter |
Sorting algorithm. | |
SorterType | sorter_type |
Sorting type. | |
bool | sort_ascending |
Whether to sort ascending or descending. | |
bool | initialized |
Whether an iteration has been started. | |
int | modifications |
Number of modification that has been done. To prevent changing data while valuating. |
Class that creates a list which can keep item/value pairs, which you can walk.
Definition at line 25 of file ai_abstractlist.hpp.
Type of sorter.
SORT_BY_VALUE |
Sort the list based on the value of the item. |
SORT_BY_ITEM |
Sort the list based on the item itself. |
Definition at line 30 of file ai_abstractlist.hpp.
void AIAbstractList::AddItem | ( | int32 | item | ) | [protected] |
Add a single item to the list.
item | the item to add. Should be unique, otherwise it is ignored. |
Definition at line 407 of file ai_abstractlist.cpp.
References buckets, HasItem(), items, and modifications.
Referenced by AddList(), AITileList::AddRectangle(), AITileList::AddTile(), AIBridgeList_Length::AIBridgeList_Length(), AICargoList_IndustryAccepting::AICargoList_IndustryAccepting(), AICargoList_IndustryProducing::AICargoList_IndustryProducing(), AIDepotList::AIDepotList(), AIEngineList::AIEngineList(), AIIndustryList_CargoAccepting::AIIndustryList_CargoAccepting(), AIIndustryList_CargoProducing::AIIndustryList_CargoProducing(), AIStationList::AIStationList(), AIStationList_Vehicle::AIStationList_Vehicle(), AIVehicleList_DefaultGroup::AIVehicleList_DefaultGroup(), AIVehicleList_Depot::AIVehicleList_Depot(), AIVehicleList_Group::AIVehicleList_Group(), AIVehicleList_SharedOrders::AIVehicleList_SharedOrders(), AIVehicleList_Station::AIVehicleList_Station(), AIWaypointList::AIWaypointList(), AIWaypointList_Vehicle::AIWaypointList_Vehicle(), and KeepList().
void AIAbstractList::AddList | ( | AIAbstractList * | list | ) |
Add one list to another one.
list | The list that will be added to the caller. |
Definition at line 523 of file ai_abstractlist.cpp.
References AddItem(), items, and SetValue().
int32 AIAbstractList::Begin | ( | ) |
Go to the beginning of the list.
Definition at line 431 of file ai_abstractlist.cpp.
References AIAbstractListSorter::Begin(), initialized, and sorter.
Referenced by _nexti().
int32 AIAbstractList::Count | ( | ) |
Returns the amount of items in the list.
Definition at line 460 of file ai_abstractlist.cpp.
References items.
Referenced by KeepBottom(), and KeepTop().
int32 AIAbstractList::GetValue | ( | int32 | item | ) |
Get the value that belongs to this item.
item | the item to get the value from |
Definition at line 465 of file ai_abstractlist.cpp.
References HasItem(), and items.
Referenced by _get(), RemoveItem(), and SetValue().
bool AIAbstractList::HasItem | ( | int32 | item | ) |
Check if an item is in the list.
item | the item to check for. |
Definition at line 393 of file ai_abstractlist.cpp.
References items.
Referenced by _get(), AIList::_set(), AddItem(), GetValue(), RemoveItem(), and SetValue().
bool AIAbstractList::HasNext | ( | ) |
Check if there is a next element.
In other words, if this is true, Next() will return a valid item.
Definition at line 451 of file ai_abstractlist.cpp.
References AIAbstractListSorter::HasNext(), initialized, and sorter.
Referenced by _nexti().
bool AIAbstractList::IsEmpty | ( | ) |
Check if a list is empty.
Definition at line 446 of file ai_abstractlist.cpp.
References items.
Referenced by _nexti().
void AIAbstractList::KeepAboveValue | ( | int32 | value | ) |
Keep all items with a higher value than 'value'.
value | the value above which all items are kept. |
Definition at line 655 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
void AIAbstractList::KeepBelowValue | ( | int32 | value | ) |
Keep all items with a lower value than 'value'.
value | the value below which all items are kept. |
Definition at line 665 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
void AIAbstractList::KeepBetweenValue | ( | int32 | start, | |
int32 | end | |||
) |
Keep all items with a value above start and below end.
start | the lower bound of the to be kept values (exclusive). | |
end | the upper bound of the to be kept values (exclusive). |
Definition at line 675 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
void AIAbstractList::KeepBottom | ( | int32 | count | ) |
Keep the last count items, i.e.
remove everything except the last count items.
count | the amount of items to keep. |
Definition at line 702 of file ai_abstractlist.cpp.
References Count(), modifications, and RemoveTop().
void AIAbstractList::KeepList | ( | AIAbstractList * | list | ) |
Keeps everything that is in the given list from this list (same item index that is).
list | the list of items to keep. |
Definition at line 709 of file ai_abstractlist.cpp.
References AddItem(), items, modifications, RemoveList(), and SetValue().
void AIAbstractList::KeepTop | ( | int32 | count | ) |
Keep the first count items, i.e.
remove everything except the first count items.
count | the amount of items to keep. |
Definition at line 695 of file ai_abstractlist.cpp.
References Count(), modifications, and RemoveBottom().
void AIAbstractList::KeepValue | ( | int32 | value | ) |
Keep all items with this value.
value | the value to keep. |
Definition at line 685 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
int32 AIAbstractList::Next | ( | ) |
Go to the next item in the list.
Definition at line 437 of file ai_abstractlist.cpp.
References initialized, AIAbstractListSorter::Next(), and sorter.
Referenced by _nexti().
void AIAbstractList::RemoveAboveValue | ( | int32 | value | ) |
Removes all items with a higher value than 'value'.
value | the value above which all items are removed. |
Definition at line 532 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
void AIAbstractList::RemoveBelowValue | ( | int32 | value | ) |
Removes all items with a lower value than 'value'.
value | the value below which all items are removed. |
Definition at line 542 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
void AIAbstractList::RemoveBetweenValue | ( | int32 | start, | |
int32 | end | |||
) |
Removes all items with a value above start and below end.
start | the lower bound of the to be removed values (exclusive). | |
end | the upper bound of the to be removed valuens (exclusive). |
Definition at line 552 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
void AIAbstractList::RemoveBottom | ( | int32 | count | ) |
Remove the last count items.
count | the amount of items to remove. |
Definition at line 609 of file ai_abstractlist.cpp.
References buckets, items, modifications, RemoveItem(), RemoveTop(), Sort(), sort_ascending, SORT_BY_ITEM, SORT_BY_VALUE, and sorter_type.
Referenced by KeepTop(), and RemoveTop().
void AIAbstractList::RemoveItem | ( | int32 | item | ) | [protected] |
Remove a single item from the list.
item | the item to remove. If not existing, it is ignored. |
Reimplemented in AIList.
Definition at line 417 of file ai_abstractlist.cpp.
References buckets, GetValue(), HasItem(), items, modifications, AIAbstractListSorter::Remove(), and sorter.
Referenced by KeepAboveValue(), KeepBelowValue(), KeepBetweenValue(), KeepValue(), RemoveAboveValue(), RemoveBelowValue(), RemoveBetweenValue(), RemoveBottom(), RemoveList(), AITileList::RemoveRectangle(), AITileList::RemoveTile(), RemoveTop(), and RemoveValue().
void AIAbstractList::RemoveList | ( | AIAbstractList * | list | ) |
Remove everything that is in the given list from this list (same item index that is).
list | the list of items to remove. |
Definition at line 645 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
Referenced by KeepList().
void AIAbstractList::RemoveTop | ( | int32 | count | ) |
Remove the first count items.
count | the amount of items to remove. |
Definition at line 572 of file ai_abstractlist.cpp.
References buckets, items, modifications, RemoveBottom(), RemoveItem(), Sort(), sort_ascending, SORT_BY_ITEM, SORT_BY_VALUE, and sorter_type.
Referenced by KeepBottom(), and RemoveBottom().
void AIAbstractList::RemoveValue | ( | int32 | value | ) |
Remove all items with this value.
value | the value to remove. |
Definition at line 562 of file ai_abstractlist.cpp.
References items, modifications, and RemoveItem().
bool AIAbstractList::SetValue | ( | int32 | item, | |
int32 | value | |||
) |
Set a value of an item directly.
item | the item to set the value for. | |
value | the value to give to the item |
Definition at line 472 of file ai_abstractlist.cpp.
References buckets, GetValue(), HasItem(), items, modifications, AIAbstractListSorter::Remove(), and sorter.
Referenced by AIList::AddItem(), AddList(), AIList::ChangeItem(), and KeepList().
void AIAbstractList::Sort | ( | SorterType | sorter, | |
bool | ascending | |||
) |
Sort this list by the given sorter and direction.
sorter | the type of sorter to use | |
ascending | if true, lowest value is on top, else at bottom. |
Definition at line 489 of file ai_abstractlist.cpp.
References initialized, modifications, sort_ascending, SORT_BY_ITEM, SORT_BY_VALUE, and sorter_type.
Referenced by RemoveBottom(), and RemoveTop().