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) const
	Get next ordered member when iterating.
Public Member Functions inherited from ucommon::LinkedObject
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.
LinkedObject *	getNext (void) const
	Get next effective object when iterating.
bool	is_member (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.
Public Member Functions inherited from ucommon::ObjectProtocol
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.

Protected Member Functions
	OrderedObject ()
	Construct an ordered object unattached.
	OrderedObject (const OrderedObject &from)
	OrderedObject (OrderedIndex *index)
	Construct an ordered object aot end of a an index.
Protected Member Functions inherited from ucommon::LinkedObject
	LinkedObject ()
	Construct base class unattached to anyone.
	LinkedObject (const LinkedObject &from)
	LinkedObject (LinkedObject **root)
	Construct base class attached to a chain of objects.

Friends
class	DLinkedObject
class	OrderedIndex

Additional Inherited Members
Static Public Member Functions inherited from ucommon::LinkedObject
static unsigned	count (const LinkedObject *root)
	Count the number of linked objects in a list.
static LinkedObject *	getIndexed (LinkedObject *root, unsigned index)
	Get member by index.
static void	purge (LinkedObject *root)
	Release all objects from a list.
Protected Attributes inherited from ucommon::LinkedObject
LinkedObject *	Next

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 312 of file linked.h.

Constructor & Destructor Documentation

OrderedObject()

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

delist()

void ucommon::OrderedObject::delist

(

OrderedIndex *

index

)

Remove our ordered object from an existing index.

Parameters

index

we are listed on.

enlist()

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::DLinkedObject.

enlistHead()

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.

enlistTail()

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.

getNext()

OrderedObject * ucommon::OrderedObject::getNext ( void ) const

inline

Get next ordered member when iterating.

Returns

next ordered object.

Definition at line 362 of file linked.h.

Friends And Related Symbol Documentation

DLinkedObject

friend class DLinkedObject

friend

Definition at line 315 of file linked.h.

OrderedIndex

friend class OrderedIndex

friend

Definition at line 316 of file linked.h.

---

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

• /builddir/build/BUILD/commoncpp-7.0.1/inc/ucommon/linked.h