LinkedDouble Class Reference

Self managed double linked list object chain. More...

#include <object.h>

Collaboration diagram for LinkedDouble:

Public Types
enum	InsertMode { modeAtFirst, modeAtLast, modeBefore, modeAfter }
	Requested in overloaded insert() method to indicate how to insert data into list. More...

Public Member Functions
virtual LinkedDouble *	getFirst (void)
	Get first linked object in list. More...
virtual LinkedDouble *	getLast (void)
	Gets the last object in the list. More...
virtual LinkedDouble *	getInsert (void)
	Virtual to get the insert point to use when adding new members. More...
LinkedDouble *	getNext (void)
	Get next object, for convenience. More...
LinkedDouble *	getPrev (void)
	Get prev object in the list. More...
virtual void	insert (LinkedDouble &obj, InsertMode position=modeAtLast)
	Insert object into chain at given position, as indicated by InsertMode; If no position is given, it defaults to modeAtLast, inserting element at list's end. More...
virtual void	detach (void)
	Remove object from chain. More...
LinkedDouble &	operator+= (LinkedDouble &obj)
LinkedDouble &	operator-- ()

Protected Member Functions
	LinkedDouble ()
virtual	~LinkedDouble ()
virtual void	enterLock (void)
virtual void	leaveLock (void)
virtual LinkedDouble *	firstObject ()
virtual LinkedDouble *	lastObject ()

Protected Attributes
LinkedDouble *	nextObject
LinkedDouble *	prevObject

Detailed Description

Self managed double linked list object chain.

This is used for accumulating lists by using as a base class for a derived subclass.

Author

David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org Accumulating double linked list.

Definition at line 229 of file object.h.

Member Enumeration Documentation

enum LinkedDouble::InsertMode

Requested in overloaded insert() method to indicate how to insert data into list.

Enumerator
modeAtFirst	insert at first position in list pointed by current object
modeAtLast	insert at last position in list pointed by current object
modeBefore	insert in list before current object
modeAfter	insert in list after current object

Definition at line 253 of file object.h.

Constructor & Destructor Documentation

LinkedDouble::LinkedDouble ( )

inlineprotected

Definition at line 234 of file object.h.

virtual LinkedDouble::~LinkedDouble ( )

protectedvirtual

Member Function Documentation

virtual void LinkedDouble::detach ( void  )

virtual

Remove object from chain.

virtual void LinkedDouble::enterLock ( void  )

protectedvirtual

virtual LinkedDouble* LinkedDouble::firstObject ( )

protectedvirtual

virtual LinkedDouble* LinkedDouble::getFirst ( void  )

virtual

Get first linked object in list.

This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class. Otherwise it follows list to front.

Returns

pointer to first object in list.

virtual LinkedDouble* LinkedDouble::getInsert ( void  )

virtual

Virtual to get the insert point to use when adding new members.

This may be current, or always head or always tail. As a virtual, this allows derived class to establish "policy".

Returns

pointer to insertion point in list.

virtual LinkedDouble* LinkedDouble::getLast ( void  )

virtual

Gets the last object in the list.

This normally follows the links to the end. This is a virtual because derived class may include a static member bookmark for the current end.

Returns

pointer to last object in list.

LinkedDouble* LinkedDouble::getNext ( void  )

inline

Get next object, for convenience.

Derived class may use this with a dynamic cast.

Returns

next object in list.

Definition at line 294 of file object.h.

LinkedDouble* LinkedDouble::getPrev ( void  )

inline

Get prev object in the list.

Returns

pointer to previous object.

Definition at line 302 of file object.h.

virtual void LinkedDouble::insert ( LinkedDouble &  obj, InsertMode  position = modeAtLast  )

virtual

Insert object into chain at given position, as indicated by InsertMode; If no position is given, it defaults to modeAtLast, inserting element at list's end.

Parameters

object	being inserted.
position	where object is inserted.

virtual LinkedDouble* LinkedDouble::lastObject ( )

protectedvirtual

virtual void LinkedDouble::leaveLock ( void  )

protectedvirtual

LinkedDouble& LinkedDouble::operator+=

(

LinkedDouble &

obj

)

LinkedDouble& LinkedDouble::operator--

(

)

Field Documentation

LinkedDouble* LinkedDouble::nextObject

protected

Definition at line 232 of file object.h.

LinkedDouble * LinkedDouble::prevObject

protected

Definition at line 232 of file object.h.

---

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

• object.h