logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

ost::LinkedDouble - Self managed double linked list object chain.

Author

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                            ost::LinkedDouble(3)

Constructor & Destructor Documentation

ost::LinkedDouble::LinkedDouble()[inline],[protected]virtualost::LinkedDouble::~LinkedDouble()[protected],[virtual]

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@gnutelephony.org

       Accumulating double linked list.

Member Data Documentation

LinkedDouble*ost::LinkedDouble::nextObject[protected]LinkedDouble*ost::LinkedDouble::prevObject[protected]

Member Enumeration Documentation

enumost::LinkedDouble::InsertMode
       Requested in overloaded insert() method to indicate how to insert data into list.

       EnumeratormodeAtFirst
              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

Member Function Documentation

virtualvoidost::LinkedDouble::detach(void)[virtual]
       Remove object from chain.

   virtualvoidost::LinkedDouble::enterLock(void)[protected],[virtual]virtualLinkedDouble*ost::LinkedDouble::firstObject()[protected],[virtual]virtualLinkedDouble*ost::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.

   virtualLinkedDouble*ost::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.

   virtualLinkedDouble*ost::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*ost::LinkedDouble::getNext(void)[inline]
       Get next object, for convenience. Derived class may use this with a dynamic cast.

       Returns
           next object in list.

   LinkedDouble*ost::LinkedDouble::getPrev(void)[inline]
       Get prev object in the list.

       Returns
           pointer to previous object.

   virtualvoidost::LinkedDouble::insert(LinkedDouble&obj,InsertModeposition=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.

       Parametersobject being inserted.
           position where object is inserted.

   virtualLinkedDouble*ost::LinkedDouble::lastObject()[protected],[virtual]virtualvoidost::LinkedDouble::leaveLock(void)[protected],[virtual]LinkedDouble&ost::LinkedDouble::operator+=(LinkedDouble&obj)LinkedDouble&ost::LinkedDouble::operator--()

Name

       ost::LinkedDouble - Self managed double linked list object chain.

Synopsis

       #include <object.h>

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

   PublicMemberFunctions
       virtual LinkedDouble * getFirst (void)
           Get first linked object in list.
       virtual LinkedDouble * getLast (void)
           Gets the last object in the list.
       virtual LinkedDouble * getInsert (void)
           Virtual to get the insert point to use when adding new members.
       LinkedDouble * getNext (void)
           Get next object, for convenience.
       LinkedDouble * getPrev (void)
           Get prev object in the list.
       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.
       virtual void detach (void)
           Remove object from chain.
       LinkedDouble & operator+= (LinkedDouble &obj)
       LinkedDouble & operator-- ()

   ProtectedMemberFunctionsLinkedDouble ()
       virtual ~LinkedDouble ()
       virtual void enterLock (void)
       virtual void leaveLock (void)
       virtual LinkedDouble * firstObject ()
       virtual LinkedDouble * lastObject ()

   ProtectedAttributesLinkedDouble * nextObjectLinkedDouble * prevObject

See Also