vtkObjectPriorityQueue Class Reference

#include <vtkObjectPriorityQueue.h>

Inheritance diagram for vtkObjectPriorityQueue:

[legend]Collaboration diagram for vtkObjectPriorityQueue:

[legend]List of all members.

---

Detailed Description

A queue object for objects.

Calls Register when objects are pushed onto the queue and UnRegister when the object is popped.

Author:

Sean McInerney

Version:

Revision

1.7

Date:

Date

2004/06/03 18:58:28

See also:

vtkObjectBasePriorityQueue vtkObject

Definition at line 36 of file vtkObjectPriorityQueue.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectPriorityQueue, vtkObjectBasePriorityQueue)
virtual vtkObject *	Top (void) const
	Get a pointer to the object at the first element of the queue.
virtual int	Push (vtkObject *object, int priority=0)
	Add an object pointer to the end of the queue.
vtkObjectPriorityQueueIterator *	CreateIterator (void)
	Create an iterator.
Static Public Member Functions
vtkObjectPriorityQueue *	New (void)
Protected Member Functions
	vtkObjectPriorityQueue (void)
	~vtkObjectPriorityQueue ()

---

Constructor & Destructor Documentation

vtkObjectPriorityQueue::vtkObjectPriorityQueue (  void   )  [inline, protected]

Definition at line 68 of file vtkObjectPriorityQueue.h.

vtkObjectPriorityQueue::~vtkObjectPriorityQueue (   )  [inline, protected]

Definition at line 69 of file vtkObjectPriorityQueue.h.

---

Member Function Documentation

vtkObjectPriorityQueueIterator* vtkObjectPriorityQueue::CreateIterator (  void   )  [virtual]

Create an iterator. Reimplemented from vtkObjectBasePriorityQueue. Reimplemented in vtkExtensionsObjectPriorityQueue.

vtkObjectPriorityQueue* vtkObjectPriorityQueue::New (  void   )  [static]

Reimplemented from vtkObjectBasePriorityQueue. Reimplemented in vtkExtensionsObjectPriorityQueue.

virtual int vtkObjectPriorityQueue::Push (  vtkObject *  object, int  priority = 0 )  [inline, virtual]

Add an object pointer to the end of the queue. Parameters: object  The object pointer to be added. priority  The priority value of the object. This is a typical queue operation. The function creates an element at the end of the queue and assigns the given object pointer to it. Returns: true on success, false otherwise. Definition at line 60 of file vtkObjectPriorityQueue.h.

virtual vtkObject* vtkObjectPriorityQueue::Top (  void   )  const [inline, virtual]

Get a pointer to the object at the first element of the queue. Returns: A pointer to the first object on success, NULL otherwise. Reimplemented from vtkObjectBasePriorityQueue. Reimplemented in vtkExtensionsObjectPriorityQueue. Definition at line 47 of file vtkObjectPriorityQueue.h.

vtkObjectPriorityQueue::vtkTypeRevisionMacro (  vtkObjectPriorityQueue  , vtkObjectBasePriorityQueue  )

---

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

• vtkObjectPriorityQueue.h

---