Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

vtkExtensionsObjectPriorityQueue Class Reference

#include <vtkExtensionsObjectPriorityQueue.h>

Inheritance diagram for vtkExtensionsObjectPriorityQueue:

Inheritance graph
[legend]
Collaboration diagram for vtkExtensionsObjectPriorityQueue:

Collaboration graph
[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.2
Date:
Date
2004/06/03 18:58:28
See also:
vtkObjectPriorityQueue vtkExtensionsObject

Definition at line 36 of file vtkExtensionsObjectPriorityQueue.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkExtensionsObjectPriorityQueue, vtkObjectPriorityQueue)
virtual vtkExtensionsObjectTop (void) const
 Get a pointer to the object at the first element of the queue.

virtual int Push (vtkExtensionsObject *object, int priority=0)
 Add an object pointer to the end of the queue.

vtkExtensionsObjectPriorityQueueIteratorCreateIterator (void)
 Create an iterator.


Static Public Member Functions

vtkExtensionsObjectPriorityQueueNew (void)

Protected Member Functions

 vtkExtensionsObjectPriorityQueue (void)
 ~vtkExtensionsObjectPriorityQueue ()


Constructor & Destructor Documentation

vtkExtensionsObjectPriorityQueue::vtkExtensionsObjectPriorityQueue void   )  [inline, protected]
 

Definition at line 68 of file vtkExtensionsObjectPriorityQueue.h.

vtkExtensionsObjectPriorityQueue::~vtkExtensionsObjectPriorityQueue  )  [inline, protected]
 

Definition at line 69 of file vtkExtensionsObjectPriorityQueue.h.


Member Function Documentation

vtkExtensionsObjectPriorityQueueIterator* vtkExtensionsObjectPriorityQueue::CreateIterator void   )  [virtual]
 

Create an iterator.

Reimplemented from vtkObjectPriorityQueue.

vtkExtensionsObjectPriorityQueue* vtkExtensionsObjectPriorityQueue::New void   )  [static]
 

Reimplemented from vtkObjectPriorityQueue.

virtual int vtkExtensionsObjectPriorityQueue::Push vtkExtensionsObject 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 61 of file vtkExtensionsObjectPriorityQueue.h.

virtual vtkExtensionsObject* vtkExtensionsObjectPriorityQueue::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 vtkObjectPriorityQueue.

Definition at line 48 of file vtkExtensionsObjectPriorityQueue.h.

vtkExtensionsObjectPriorityQueue::vtkTypeRevisionMacro vtkExtensionsObjectPriorityQueue  ,
vtkObjectPriorityQueue 
 

Reimplemented from vtkExtensionsObject.


The documentation for this class was generated from the following file:
Generated on Tue Aug 10 03:43:08 2004 for vtkExtensions by doxygen 1.3.7