alias_api.AlList

class alias_api.AlList

Bases: pybind11_object

Simple List class for AlLinkItem objects.

This simple container class provides the ability to create and access a list of objects derived from the AlLinkItem class.

append(self: alias_api.AlList, item: alias_api.AlLinkItem) → None

Adds an AlLinkItem object to the end of the list.

Parameters

item (AlLinkItem) – The object to be appended.

clear(self: alias_api.AlList) → None

Clears the list as an empty list but does not free any of its members.

first(self: alias_api.AlList) → alias_api.AlLinkItem

Return the first element of the list.

last(self: alias_api.AlList) → alias_api.AlLinkItem

Return the last element of the list.

remove(self: alias_api.AlList, item: alias_api.AlLinkItem) → int

Removes an AlLinkItem object from the AlList. Returns 1 if the item was removed, 0 if it was not (because it did not belong in this list).

Parameters

item (AlLinkItem) – The object to be appended.

Returns

1 if the item was removed, 0 otherwise.

Return type

int