ost::linkedsingle(3)
NAME
ost::LinkedSingle - Self managed single linked list object chain.
SYNOPSIS
#include <object.h> Public Member Functions virtual LinkedSingle * getFirst (void) Get first linked object in list. virtual LinkedSingle * getLast (void) Gets the last object in the list. LinkedSingle * getNext (void) Get next object, for convenience. virtual void insert (LinkedSingle &obj) Insert object into chain. LinkedSingle & operator+= (LinkedSingle &obj) Protected Member Functions LinkedSingle () virtual ~LinkedSingle () Protected Attributes LinkedSingle * nextObject
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@gnutelephony.org> Accumulating single linked
list.
Constructor & Destructor Documentation
ost::LinkedSingle::LinkedSingle () [inline, protected] virtual ost::LinkedSingle::~LinkedSingle () [protected, virtual]
Member Function Documentation
- virtual LinkedSingle* ost::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* ost::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* ost::LinkedSingle::getNext (void) [inline]
- Get next object, for convenience.
- Derived class may use this with a dynamic cast.
- Returns:
next object in list.
- virtual void ost::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:
object being inserted.
- LinkedSingle& ost::LinkedSingle::operator+= (LinkedSingle & obj)
Member Data Documentation
LinkedSingle* ost::LinkedSingle::nextObject [protected]
Author
- Generated automatically by Doxygen for GNU CommonC++ from the source
code.