ucommon::OrderedObject Class Reference

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

#include <linked.h>

Inheritance diagram for ucommon::OrderedObject:

Collaboration diagram for ucommon::OrderedObject:

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.
OrderedObject *	getNext (void)
	Get next ordered member when iterating.
Protected Member Functions
	OrderedObject (OrderedIndex *index)
	Construct an ordered object aot end of a an index.
	OrderedObject ()
	Construct an ordered object unattached.
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 293 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

)

[inline]

Get next ordered member when iterating.

Returns:

next ordered object.

Reimplemented from ucommon::LinkedObject.

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

Definition at line 342 of file linked.h.

---

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

• ucommon/linked.h