A linked object base class for ordered objects.
More...
#include <linked.h>
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) const |
| Get next ordered member when iterating.
|
void | delist (LinkedObject **root) |
| Locate and remove ourselves from a list of objects.
|
void | enlist (LinkedObject **root) |
| Add our object to an existing linked list through a pointer.
|
bool | isMember (LinkedObject *list) const |
| Search to see if we are a member of a specific list.
|
virtual void | release (void) |
| Release list, mark as no longer linked.
|
virtual void | retain (void) |
| Retain by marking as self referenced list.
|
ObjectProtocol * | copy (void) |
| Retain (increase retention of) object when copying.
|
void | operator++ (void) |
| Increase retention operator.
|
void | operator-- (void) |
| Decrease retention operator.
|
virtual | ~ObjectProtocol () |
| Required virtual destructor.
|
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.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..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
-
Member Function Documentation
Remove our ordered object from an existing index.
- Parameters
-
virtual void ucommon::OrderedObject::enlist |
( |
OrderedIndex * |
index | ) |
|
|
virtual |
List our ordered object in default strategy mode.
The default base class uses enlistTail.
- Parameters
-
Reimplemented in ucommon::LinkedList.
void ucommon::OrderedObject::enlistHead |
( |
OrderedIndex * |
index | ) |
|
List our ordered object at start of a linked list on an index.
- Parameters
-
Reimplemented in ucommon::LinkedList.
void ucommon::OrderedObject::enlistTail |
( |
OrderedIndex * |
index | ) |
|
List our ordered object at end of a linked list on an index.
- Parameters
-
Reimplemented in ucommon::LinkedList.
The documentation for this class was generated from the following file: