vtkObjectPriorityQueue Class Reference

#include <vtkObjectPriorityQueue.h>

Inheritance diagram for vtkObjectPriorityQueue:

[legend]Collaboration diagram for vtkObjectPriorityQueue:

[legend]List of all members.

---

Detailed Description

A priority queue container for objects.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2005/06/24 23:17:16

See also:

vtkObjectBasePriorityQueue vtkObject

Definition at line 30 of file vtkObjectPriorityQueue.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectPriorityQueue, vtkObjectBasePriorityQueue)
void	PrintSelf (ostream &, vtkIndent)
virtual int	Swap (vtkObjectPriorityQueue *container)
	Swaps items of this container with those of the specified container.
virtual int	Copy (vtkObjectPriorityQueue *container)
	Copy all items from the specified container into this container.
virtual int	Push (vtkObject *item, int priority=0)
	Add an item to the end of the queue with an optional priority value.
vtkObject *	Top (void) const
	Returns the first item in this queue on success, NULL otherwise.
Static Public Member Functions
vtkObjectPriorityQueue *	New (void)
Protected Member Functions
	vtkObjectPriorityQueue (void)
	~vtkObjectPriorityQueue ()

---

Constructor & Destructor Documentation

vtkObjectPriorityQueue::vtkObjectPriorityQueue (  void   )  [protected]

vtkObjectPriorityQueue::~vtkObjectPriorityQueue (   )  [protected]

---

Member Function Documentation

virtual int vtkObjectPriorityQueue::Copy (  vtkObjectPriorityQueue *  container  )  [inline, virtual]

Copy all items from the specified container into this container. Returns: true on success, otherwise false. Definition at line 50 of file vtkObjectPriorityQueue.h.

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

Reimplemented from vtkObjectBasePriorityQueue.

void vtkObjectPriorityQueue::PrintSelf (  ostream &  , vtkIndent  )  [virtual]

Reimplemented from vtkObjectBasePriorityQueue.

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

Add an item to the end of the queue with an optional priority value. Parameters: item  The object to be added. priority  The priority value of the object. Returns: true on success, false otherwise. Definition at line 60 of file vtkObjectPriorityQueue.h.

virtual int vtkObjectPriorityQueue::Swap (  vtkObjectPriorityQueue *  container  )  [inline, virtual]

Swaps items of this container with those of the specified container. Returns: true on success, otherwise false. Definition at line 43 of file vtkObjectPriorityQueue.h.

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

Returns the first item in this queue on success, NULL otherwise. Reimplemented from vtkObjectBasePriorityQueue. Definition at line 65 of file vtkObjectPriorityQueue.h.

vtkObjectPriorityQueue::vtkTypeRevisionMacro (  vtkObjectPriorityQueue  , vtkObjectBasePriorityQueue  )

---

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

• vtkObjectPriorityQueue.h

---