vtkObjectBaseQueue Class Reference

#include <vtkObjectBaseQueue.h>

Inheritance diagram for vtkObjectBaseQueue:

[legend]Collaboration diagram for vtkObjectBaseQueue:

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

Date:

Date

2004/06/03 18:58:28

See also:

vtkObjectBase

Definition at line 38 of file vtkObjectBaseQueue.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectBaseQueue, vtkContainer)
vtkIdType	GetSize (void) const
	Returns the number of elements in the queue.
int	IsEmpty (void) const
	Returns true if the queue is empty.
vtkIdType	GetMaxSize (void) const
	Returns the maximum size of the queue.
void	Clear (void)
	Remove ALL elements.
virtual int	Swap (vtkObjectBaseQueue *container)
	Swaps elements of this object with those of the specified container.
vtkObjectBaseQueueIterator *	CreateIterator (void)
	Create an iterator.
Queue Operations
virtual int	Push (vtkObjectBase *object)
	Add an object pointer to the end of the queue.
int	Pop (void)
	Removes the first element.
Data Access Methods
vtkObjectBase *	Front (void) const
	Get a pointer to the object at the first element of the queue.
vtkObjectBase *	Back (void) const
	Get a pointer to the object at the last element of the queue.
Static Public Member Functions
vtkObjectBaseQueue *	New (void)
Protected Member Functions
	vtkObjectBaseQueue (void)
	~vtkObjectBaseQueue ()

---

Constructor & Destructor Documentation

vtkObjectBaseQueue::vtkObjectBaseQueue (  void   )  [protected]

vtkObjectBaseQueue::~vtkObjectBaseQueue (   )  [protected]

---

Member Function Documentation

vtkObjectBase* vtkObjectBaseQueue::Back (  void   )  const [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. Reimplemented from vtkContainer. Reimplemented in vtkExtensionsObjectQueue, and vtkObjectQueue.

void vtkObjectBaseQueue::Clear (  void   )  [virtual]

Remove ALL elements. Implements vtkContainer.

vtkObjectBaseQueueIterator* vtkObjectBaseQueue::CreateIterator (  void   )  [virtual]

Create an iterator. Implements vtkContainer. Reimplemented in vtkExtensionsObjectQueue, and vtkObjectQueue.

vtkObjectBase* vtkObjectBaseQueue::Front (  void   )  const [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 vtkContainer. Reimplemented in vtkExtensionsObjectQueue, and vtkObjectQueue.

vtkIdType vtkObjectBaseQueue::GetMaxSize (  void   )  const [virtual]

Returns the maximum size of the queue. Reimplemented from vtkContainer.

vtkIdType vtkObjectBaseQueue::GetSize (  void   )  const [virtual]

Returns the number of elements in the queue. Reimplemented from vtkContainer.

int vtkObjectBaseQueue::IsEmpty (  void   )  const [virtual]

Returns true if the queue is empty. Reimplemented from vtkContainer.

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

Reimplemented from vtkExtensionsObject. Reimplemented in vtkExtensionsObjectQueue, and vtkObjectQueue.

int vtkObjectBaseQueue::Pop (  void   )

Removes the first element. This is a typical queue operation. It shrinks the queue by one. Note: No object is returned, and if the first element's object pointer is needed, it should be retrieved before Pop() is called. Returns: true on success, false otherwise.

virtual int vtkObjectBaseQueue::Push (  vtkObjectBase *  object  )  [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.

virtual int vtkObjectBaseQueue::Swap (  vtkObjectBaseQueue *  container  )  [virtual]

Swaps elements of this object with those of the specified container. Returns: true on success, otherwise false.

vtkObjectBaseQueue::vtkTypeRevisionMacro (  vtkObjectBaseQueue  , vtkContainer  )

---

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

• vtkObjectBaseQueue.h

---