UCommon
Public Member Functions
ucommon::objqueue< T > Class Template Reference

Template for typesafe basic object queue container. More...

#include <linked.h>

Inheritance diagram for ucommon::objqueue< T >:
Inheritance graph
[legend]
Collaboration diagram for ucommon::objqueue< T >:
Collaboration graph
[legend]

Public Member Functions

void add (T *object)
 Add an object to the end of the object queue.
 objqueue ()
 Create a new object stack.
T * pop (void)
 Pop an object from the end of the object queue.
T * pull (void)
 Pull an object from the start of the object queue.
void push (T *object)
 Push an object to start of queue.
- Public Member Functions inherited from ucommon::ObjectQueue
void add (DLinkedObject *object)
 Add an object to the end of the queue.
 ObjectQueue ()
 Create an empty object queue.
void push (DLinkedObject *object)
 Push an object to the front of the queue.
- Public Member Functions inherited from ucommon::OrderedIndex
void add (OrderedObject *ordered)
 Add an object into the ordered index.
LinkedObjectbegin (void)
 Return first object in list for iterators.
unsigned count (void)
 Count of objects this list manages.
LinkedObjectend (void)
 Return last object in list for iterators.
LinkedObjectfind (unsigned offset)
 Find a specific member in the ordered list.
LinkedObjectget (void)
 Get (pull) object off the list.
LinkedObjectgetIndexed (unsigned index)
 Get an indexed member from the ordered index.
LinkedObject ** index (void)
 Return a pointer to the head of the list.
virtual void lock_index (void)
 Used to synchronize lists managed by multiple threads.
LinkedObjectoperator* ()
 Return head object pointer.
void operator*= (OrderedObject *object)
 Add object to our list.
 OrderedIndex ()
 Create and initialize an empty index.
void purge (void)
 Purge the linked list and then set the index to empty.
void reset (void)
 Reset linked list to empty without purging.
virtual void unlock_index (void)
 Used to synchronize lists managed by multiple threads.
virtual ~OrderedIndex ()
 Destroy index.

Detailed Description

template<class T>
class ucommon::objqueue< T >

Template for typesafe basic object queue container.

The object type, T, that is contained in the fifo must be derived from DLinkedObject.

Author:
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 1232 of file linked.h.


Member Function Documentation

template<class T >
void ucommon::objqueue< T >::add ( T *  object)
inline

Add an object to the end of the object queue.

Parameters:
objectof specified type to add.

Definition at line 1251 of file linked.h.

Here is the call graph for this function:

template<class T >
T* ucommon::objqueue< T >::pop ( void  )
inline

Pop an object from the end of the object queue.

Returns:
object of specified type or NULL if empty.

Reimplemented from ucommon::ObjectQueue.

Definition at line 1265 of file linked.h.

Here is the call graph for this function:

template<class T >
T* ucommon::objqueue< T >::pull ( void  )
inline

Pull an object from the start of the object queue.

Returns:
object of specified type or NULL if empty.

Reimplemented from ucommon::ObjectQueue.

Definition at line 1258 of file linked.h.

Here is the call graph for this function:

template<class T >
void ucommon::objqueue< T >::push ( T *  object)
inline

Push an object to start of queue.

Parameters:
objectof specified type to push.

Definition at line 1244 of file linked.h.

Here is the call graph for this function:


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