ucc::OrderedIndex Class Reference

An index container for maintaining an ordered list of objects. More...

#include <linked.h>

Inheritance diagram for ucc::OrderedIndex:
Inheritance graph
[legend]
Collaboration diagram for ucc::OrderedIndex:
Collaboration graph
[legend]

Public Member Functions

void add (OrderedObject *ordered)
 Add an object into the ordered index.
LinkedObjectbegin (void)
 Return first object in list for iterators.
unsigned count (void)
 Count of objects this list manages.
LinkedObjectend (void)
 Return last object in list for iterators.
LinkedObjectfind (unsigned offset)
 Find a specific member in the ordered list.
LinkedObjectget (void)
 Get (pull) object off the list.
LinkedObjectgetIndexed (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.
LinkedObjectoperator* ()
 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.
virtual void unlock_index (void)
 Used to synchronize lists managed by multiple threads.
virtual ~OrderedIndex ()
 Destroy index.

Protected Attributes

OrderedObjecthead
OrderedObjecttail

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. Fundimental methods for supporting iterators are also provided.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 175 of file linked.h.


Member Function Documentation

void ucc::OrderedIndex::add ( OrderedObject ordered  ) 

Add an object into the ordered index.

Parameters:
ordered object to add to the index.
LinkedObject* ucc::OrderedIndex::begin ( void   )  [inline]

Return first object in list for iterators.

Returns:
first object in list.

Reimplemented in ucc::keylist< T >.

Definition at line 258 of file linked.h.

unsigned ucc::OrderedIndex::count ( void   ) 

Count of objects this list manages.

Returns:
number of objects in the list.
LinkedObject* ucc::OrderedIndex::end ( void   )  [inline]

Return last object in list for iterators.

Returns:
last object in list.

Reimplemented in ucc::keylist< T >.

Definition at line 265 of file linked.h.

LinkedObject* ucc::OrderedIndex::find ( unsigned  offset  ) 

Find a specific member in the ordered list.

Parameters:
offset to member to find.
LinkedObject* ucc::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* ucc::OrderedIndex::getIndexed ( unsigned  index  )  [inline]

Get an indexed member from the ordered index.

Parameters:
index of member to fetch.
Returns:
LinkedObject member of index.

Definition at line 251 of file linked.h.

LinkedObject** ucc::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 ucc::keylist< T >.

virtual void ucc::OrderedIndex::lock_index ( void   )  [virtual]

Used to synchronize lists managed by multiple threads.

A derived locking method would be invoked.

LinkedObject* ucc::OrderedIndex::operator* (  )  [inline]

Return head object pointer.

Returns:
head pointer.

Definition at line 272 of file linked.h.

void ucc::OrderedIndex::operator*= ( OrderedObject object  ) 

Add object to our list.

Parameters:
object to add.
virtual void ucc::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:
Generated by  doxygen 1.6.2-20100208