vtkObjectQueue Class Reference

#include <vtkObjectQueue.h>

Inheritance diagram for vtkObjectQueue:

[legend]Collaboration diagram for vtkObjectQueue:

[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.6

Date:

Date

2004/06/03 18:58:29

See also:

vtkObjectBaseQueue vtkObject

Definition at line 36 of file vtkObjectQueue.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectQueue, vtkObjectBaseQueue)
virtual vtkObject *	Front (void) const
	Get a pointer to the object at the first element of the queue.
virtual vtkObject *	Back (void) const
	Get a pointer to the object at the last element of the queue.
virtual int	Push (vtkObject *object)
	Add an object pointer to the end of the queue.
vtkObjectQueueIterator *	CreateIterator (void)
	Create an iterator.
Static Public Member Functions
vtkObjectQueue *	New (void)
Protected Member Functions
	vtkObjectQueue (void)
	~vtkObjectQueue ()

---

Constructor & Destructor Documentation

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

Definition at line 77 of file vtkObjectQueue.h.

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

Definition at line 78 of file vtkObjectQueue.h.

---

Member Function Documentation

virtual vtkObject* vtkObjectQueue::Back (  void   )  const [inline, virtual]

Get a pointer to the object at the last element of the queue. Returns: A pointer to the last object on success, NULL otherwise. Note: Covariant return type. Reimplemented from vtkObjectBaseQueue. Reimplemented in vtkExtensionsObjectQueue. Definition at line 58 of file vtkObjectQueue.h.

vtkObjectQueueIterator* vtkObjectQueue::CreateIterator (  void   )  [virtual]

Create an iterator. Reimplemented from vtkObjectBaseQueue. Reimplemented in vtkExtensionsObjectQueue.

virtual vtkObject* vtkObjectQueue::Front (  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. Note: Covariant return type. Reimplemented from vtkObjectBaseQueue. Reimplemented in vtkExtensionsObjectQueue. Definition at line 49 of file vtkObjectQueue.h.

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

Reimplemented from vtkObjectBaseQueue. Reimplemented in vtkExtensionsObjectQueue.

virtual int vtkObjectQueue::Push (  vtkObject *  object  )  [inline, virtual]

Add an object pointer to the end of the queue. Parameters: object  The object pointer to be added. 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 70 of file vtkObjectQueue.h.

vtkObjectQueue::vtkTypeRevisionMacro (  vtkObjectQueue  , vtkObjectBaseQueue  )

---

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

• vtkObjectQueue.h

---