Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes
LinkedSingle Class Reference

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

#include <object.h>

Collaboration diagram for LinkedSingle:
Collaboration graph
[legend]

Public Member Functions

virtual LinkedSinglegetFirst (void)
 Get first linked object in list. More...
 
virtual LinkedSinglegetLast (void)
 Gets the last object in the list. More...
 
LinkedSinglegetNext (void)
 Get next object, for convenience. More...
 
virtual void insert (LinkedSingle &obj)
 Insert object into chain. More...
 
LinkedSingleoperator+= (LinkedSingle &obj)
 

Protected Member Functions

 LinkedSingle ()
 
virtual ~LinkedSingle ()
 

Protected Attributes

LinkedSinglenextObject
 

Detailed Description

Self managed single 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 single linked list.

Definition at line 170 of file object.h.

Constructor & Destructor Documentation

LinkedSingle::LinkedSingle ( )
inlineprotected

Definition at line 175 of file object.h.

virtual LinkedSingle::~LinkedSingle ( )
protectedvirtual

Member Function Documentation

virtual LinkedSingle* LinkedSingle::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 simply returns the current object. In a "free" list, this may not only return the first object, but also set the first to next.

Returns
pointer to first object in list.
virtual LinkedSingle* LinkedSingle::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.
LinkedSingle* LinkedSingle::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 207 of file object.h.

virtual void LinkedSingle::insert ( LinkedSingle obj)
virtual

Insert object into chain.

This is a virtual because derived class may choose instead to perform an insert at head or tail, may manage bookmarks, and may add mutex lock.

Parameters
objectbeing inserted.
LinkedSingle& LinkedSingle::operator+= ( LinkedSingle obj)

Field Documentation

LinkedSingle* LinkedSingle::nextObject
protected

Definition at line 173 of file object.h.


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