An index container for maintaining an ordered list of objects.
More...
#include <linked.h>
An index container for maintaining an ordered list of objects.
This index holds a pointer to the head and tail of an ordered list of linked objects. Fundamental methods for supporting iterators are also provided.
- Author
- David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org
- Examples
- linked.cpp.
Definition at line 176 of file linked.h.
◆ OrderedIndex()
ucommon::OrderedIndex::OrderedIndex |
( |
const OrderedIndex & | source | ) |
|
|
inline |
◆ add()
Add an object into the ordered index.
- Parameters
-
ordered | object to add to the index. |
◆ begin()
Return first object in list for iterators.
- Returns
- first object in list.
Definition at line 270 of file linked.h.
◆ count()
unsigned ucommon::OrderedIndex::count |
( |
void | | ) |
const |
Count of objects this list manages.
- Returns
- number of objects in the list.
◆ end()
Return last object in list for iterators.
- Returns
- last object in list.
Definition at line 278 of file linked.h.
◆ find()
LinkedObject * ucommon::OrderedIndex::find |
( |
unsigned | offset | ) |
const |
Find a specific member in the ordered list.
- Parameters
-
◆ get()
Get (pull) object off the list.
The start of the list is advanced to the next object.
- Returns
- LinkedObject based object that was head of the list.
◆ getIndexed()
LinkedObject * ucommon::OrderedIndex::getIndexed |
( |
unsigned | index | ) |
const |
|
inline |
Get an indexed member from the ordered index.
- Parameters
-
- Returns
- LinkedObject member of index.
Definition at line 262 of file linked.h.
◆ index()
Return a pointer to the head of the list.
This allows the head pointer to be used like a simple root list pointer for pure LinkedObject based objects.
- Returns
- LinkedIndex style object.
◆ lock_index()
virtual void ucommon::OrderedIndex::lock_index |
( |
void | | ) |
|
|
virtual |
Used to synchronize lists managed by multiple threads.
A derived locking method would be invoked.
◆ operator*()
Return head object pointer.
- Returns
- head pointer.
Definition at line 286 of file linked.h.
◆ operator*=()
Add object to our list.
- Parameters
-
◆ operator=()
Assign ordered index.
- Parameters
-
Definition at line 294 of file linked.h.
◆ unlock_index()
virtual void ucommon::OrderedIndex::unlock_index |
( |
void | | ) |
|
|
virtual |
Used to synchronize lists managed by multiple threads.
A derived unlocking method would be invoked.
◆ DLinkedObject
◆ NamedObject
◆ OrderedObject
◆ head
◆ tail
The documentation for this class was generated from the following file:
- /builddir/build/BUILD/ucommon-7.0.0-build/ucommon-7.0.0/inc/ucommon/linked.h