OpenDDS::DCPS::BasicQueueVisitor< T > Class Template Reference

#include <BasicQueueVisitor_T.h>

Inheritance diagram for OpenDDS::DCPS::BasicQueueVisitor< T >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 BasicQueueVisitor ()
virtual ~BasicQueueVisitor ()
virtual int visit_element (T *element)
virtual int visit_element_remove (T *element, int &remove)
virtual int visit_element_ref (T *&element)

template<typename T>
class OpenDDS::DCPS::BasicQueueVisitor< T >


Constructor & Destructor Documentation

template<typename T>
OpenDDS::DCPS::BasicQueueVisitor< T >::BasicQueueVisitor (  )  [inline]

template<typename T>
virtual OpenDDS::DCPS::BasicQueueVisitor< T >::~BasicQueueVisitor (  )  [inline, virtual]


Member Function Documentation

template<typename T>
virtual int OpenDDS::DCPS::BasicQueueVisitor< T >::visit_element ( T *  element  )  [inline, virtual]

This is the visit_element() method that will be called when the visitation method used is BasicQueue<T>::accept_visitor().

Return 0 if visiting should stop, return 1 to continue visiting.

template<typename T>
virtual int OpenDDS::DCPS::BasicQueueVisitor< T >::visit_element_ref ( T *&  element  )  [inline, virtual]

This is the visit_element_ref() method that will be called when the visitation method used is BasicQueue<T>::accept_replace_visitor().

Return 0 if visiting should stop, return 1 to continue visiting.

template<typename T>
virtual int OpenDDS::DCPS::BasicQueueVisitor< T >::visit_element_remove ( T *  element,
int &  remove 
) [inline, virtual]

This is the visit_element_remove() method that will be called when the visitation method used is BasicQueue<T>::accept_remove_visitor().

Return 0 if visiting should stop, return 1 to continue visiting. The remove is an "inout" argument that is always passed-in with a false (0) value, indicating that the link should not be removed from the queue as a result of this visit. If the visit_remove() implementation decides that the link should be removed, then it must set the remove argument to true (1). By default, this method is implemented to just return 0 to stop the "remove visitation" immediately. It doesn't modify the value of the remove argument.


The documentation for this class was generated from the following file:
Generated on Fri Jun 20 10:21:46 2008 for OpenDDS by  doxygen 1.4.7