vtkObjectQueue Class Reference

#include <vtkObjectQueue.h>

Inheritance diagram for vtkObjectQueue:

[legend]Collaboration diagram for vtkObjectQueue:

[legend]List of all members.

---

Detailed Description

A queue container for objects.

Author:

Sean McInerney

Version:

Revision

1.3

Date:

Date

2005/06/24 23:17:16

See also:

vtkObjectBaseQueue vtkObject

Definition at line 30 of file vtkObjectQueue.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectQueue, vtkObjectBaseQueue)
void	PrintSelf (ostream &, vtkIndent)
virtual int	Swap (vtkObjectQueue *container)
	Swaps items of this container with those of the specified container.
virtual int	Copy (vtkObjectQueue *container)
	Copy all items from the specified container into this container.
virtual int	Push (vtkObject *item)
	Add an item to the end of the queue.
vtkObject *	At (vtkIdType position) const
	Provides access by index to the objects contained in this queue.
vtkObject *	Front (void) const
	Returns the first item in the container, or null if the container is empty.
vtkObject *	Back (void) const
	Returns the last item in the container, or null if the container is empty.
Static Public Member Functions
vtkObjectQueue *	New (void)
Protected Member Functions
	vtkObjectQueue (void)
	~vtkObjectQueue ()

---

Constructor & Destructor Documentation

vtkObjectQueue::vtkObjectQueue (  void   )  [protected]

vtkObjectQueue::~vtkObjectQueue (   )  [protected]

---

Member Function Documentation

vtkObject* vtkObjectQueue::At (  vtkIdType  position  )  const [inline, virtual]

Provides access by index to the objects contained in this queue. Parameters: position  The item index for which object should be accessed. Returns: the item if position is a valid index, otherwise null. Reimplemented from vtkObjectBaseQueue. Definition at line 67 of file vtkObjectQueue.h.

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

Returns the last item in the container, or null if the container is empty. Reimplemented from vtkObjectBaseQueue. Definition at line 81 of file vtkObjectQueue.h.

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

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

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

Returns the first item in the container, or null if the container is empty. Reimplemented from vtkObjectBaseQueue. Definition at line 74 of file vtkObjectQueue.h.

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

Reimplemented from vtkObjectBaseQueue.

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

Reimplemented from vtkObjectBaseQueue.

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

Add an item to the end of the queue. Parameters: item  The object to be added. Returns: true on success, false otherwise. Definition at line 58 of file vtkObjectQueue.h.

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

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

vtkObjectQueue::vtkTypeRevisionMacro (  vtkObjectQueue  , vtkObjectBaseQueue  )

---

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

• vtkObjectQueue.h

---