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) const |
| Return first object in list for iterators.
|
unsigned | count (void) const |
| Count of objects this list manages.
|
LinkedObject * | end (void) const |
| Return last object in list for iterators.
|
LinkedObject * | find (unsigned offset) const |
| Find a specific member in the ordered list.
|
LinkedObject * | get (void) |
| Get (pull) object off the list.
|
LinkedObject * | getIndexed (unsigned index) const |
| Get an indexed member from the ordered index.
|
LinkedObject ** | index (void) const |
| Return a pointer to the head of the list.
|
virtual void | lock_index (void) |
| Used to synchronize lists managed by multiple threads.
|
LinkedObject * | operator* () const |
| 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.
|
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.
- Author
- David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org
Definition at line 175 of file linked.h.
Member Function Documentation
Add an object into the ordered index.
- Parameters
-
ordered | object to add to the index. |
Return first object in list for iterators.
- Returns
- first object in list.
Definition at line 263 of file linked.h.
unsigned ucommon::OrderedIndex::count |
( |
void |
| ) |
const |
Count of objects this list manages.
- Returns
- number of objects in the list.
Return last object in list for iterators.
- Returns
- last object in list.
Definition at line 270 of file linked.h.
LinkedObject* ucommon::OrderedIndex::find |
( |
unsigned |
offset | ) |
const |
Find a specific member in the ordered list.
- Parameters
-
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 | ) |
const |
|
inline |
Get an indexed member from the ordered index.
- Parameters
-
- Returns
- LinkedObject member of index.
Definition at line 256 of file linked.h.
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.
virtual void ucommon::OrderedIndex::lock_index |
( |
void |
| ) |
|
|
virtual |
Used to synchronize lists managed by multiple threads.
A derived locking method would be invoked.
Return head object pointer.
- Returns
- head pointer.
Definition at line 277 of file linked.h.
Add object to our list.
- Parameters
-
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: