ucommon::OrderedObject Class Reference

A linked object base class for ordered objects. More...

#include <linked.h>

Inheritance diagram for ucommon::OrderedObject:
Inheritance graph
[legend]
Collaboration diagram for ucommon::OrderedObject:
Collaboration graph
[legend]

Public Member Functions

void delist (OrderedIndex *index)
 Remove our ordered object from an existing index.
virtual void enlist (OrderedIndex *index)
 List our ordered object in default strategy mode.
void enlistHead (OrderedIndex *index)
 List our ordered object at start of a linked list on an index.
void enlistTail (OrderedIndex *index)
 List our ordered object at end of a linked list on an index.
OrderedObjectgetNext (void) const
 Get next ordered member when iterating.

Protected Member Functions

 OrderedObject ()
 Construct an ordered object unattached.
 OrderedObject (OrderedIndex *index)
 Construct an ordered object aot end of a an index.

Friends

class DLinkedObject
class LinkedList
class ObjectQueue
class OrderedIndex

Detailed Description

A linked object base class for ordered objects.

This is used for objects that must be ordered and listed through the OrderedIndex class.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 305 of file linked.h.


Constructor & Destructor Documentation

ucommon::OrderedObject::OrderedObject ( OrderedIndex index  )  [protected]

Construct an ordered object aot end of a an index.

Parameters:
index we are listed on.

Member Function Documentation

void ucommon::OrderedObject::delist ( OrderedIndex index  ) 

Remove our ordered object from an existing index.

Parameters:
index we are listed on.
virtual void ucommon::OrderedObject::enlist ( OrderedIndex index  )  [virtual]

List our ordered object in default strategy mode.

The default base class uses enlistTail.

Parameters:
index we are listing on.

Reimplemented in ucommon::LinkedList.

void ucommon::OrderedObject::enlistHead ( OrderedIndex index  ) 

List our ordered object at start of a linked list on an index.

Parameters:
index we are listing on.

Reimplemented in ucommon::LinkedList.

void ucommon::OrderedObject::enlistTail ( OrderedIndex index  ) 

List our ordered object at end of a linked list on an index.

Parameters:
index we are listing on.

Reimplemented in ucommon::LinkedList.

OrderedObject* ucommon::OrderedObject::getNext ( void   )  const [inline]

Get next ordered member when iterating.

Returns:
next ordered object.

Reimplemented from ucommon::LinkedObject.

Reimplemented in ucommon::NamedObject, and ucommon::LinkedList.

Definition at line 354 of file linked.h.


The documentation for this class was generated from the following file:

Generated on 30 Jul 2013 for UCommon by  doxygen 1.6.1