An index container for maintaining an ordered list of objects. More...
#include <linked.h>
Public Member Functions | |
| void | add (OrderedObject *ordered) |
| Add an object into the ordered index. | |
| LinkedObject * | begin (void) |
| Return first object in list for iterators. | |
| unsigned | count (void) |
| Count of objects this list manages. | |
| LinkedObject * | end (void) |
| Return last object in list for iterators. | |
| LinkedObject * | find (unsigned offset) |
| Find a specific member in the ordered list. | |
| LinkedObject * | get (void) |
| Get (pull) object off the list. | |
| LinkedObject * | getIndexed (unsigned index) |
| Get an indexed member from the ordered index. | |
| LinkedObject ** | index (void) |
| Return a pointer to the head of the list. | |
| virtual void | lock_index (void) |
| Used to synchronize lists managed by multiple threads. | |
| LinkedObject * | operator* () |
| Return head object pointer. | |
| void | operator*= (OrderedObject *object) |
| Add object to our list. | |
| OrderedIndex () | |
| Create and initialize an empty index. | |
| void | purge (void) |
| Purge the linked list and then set the index to empty. | |
| void | reset (void) |
| Reset linked list to empty without purging. | |
| virtual void | unlock_index (void) |
| Used to synchronize lists managed by multiple threads. | |
| virtual | ~OrderedIndex () |
| Destroy index. | |
Protected Attributes | |
| OrderedObject * | head |
| OrderedObject * | tail |
Friends | |
| class | DLinkedObject |
| class | LinkedList |
| class | NamedObject |
| class | OrderedObject |
Detailed Description
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.
Member Function Documentation
| void ucommon::OrderedIndex::add | ( | OrderedObject * | ordered | ) |
Add an object into the ordered index.
- Parameters:
-
ordered object to add to the index.
| LinkedObject* ucommon::OrderedIndex::begin | ( | void | ) | [inline] |
Return first object in list for iterators.
- Returns:
- first object in list.
Reimplemented in ucommon::keylist< T >.
| unsigned ucommon::OrderedIndex::count | ( | void | ) |
Count of objects this list manages.
- Returns:
- number of objects in the list.
| LinkedObject* ucommon::OrderedIndex::end | ( | void | ) | [inline] |
Return last object in list for iterators.
- Returns:
- last object in list.
Reimplemented in ucommon::keylist< T >.
| LinkedObject* ucommon::OrderedIndex::find | ( | unsigned | offset | ) |
Find a specific member in the ordered list.
- Parameters:
-
offset to member to find.
| LinkedObject* ucommon::OrderedIndex::get | ( | void | ) |
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.
| LinkedObject* ucommon::OrderedIndex::getIndexed | ( | unsigned | index | ) | [inline] |
Get an indexed member from the ordered index.
- Parameters:
-
index of member to fetch.
- Returns:
- LinkedObject member of index.
| LinkedObject** ucommon::OrderedIndex::index | ( | void | ) |
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.
Reimplemented in ucommon::keylist< T >.
| virtual void ucommon::OrderedIndex::lock_index | ( | void | ) | [virtual] |
Used to synchronize lists managed by multiple threads.
A derived locking method would be invoked.
| LinkedObject* ucommon::OrderedIndex::operator* | ( | ) | [inline] |
| void ucommon::OrderedIndex::operator*= | ( | OrderedObject * | object | ) |
Add object to our list.
- Parameters:
-
object to add.
| virtual void ucommon::OrderedIndex::unlock_index | ( | void | ) | [virtual] |
Used to synchronize lists managed by multiple threads.
A derived unlocking method would be invoked.
The documentation for this class was generated from the following file:
- ucommon/linked.h
