vtkContainer Class Reference

#include <vtkContainer.h>

Inheritance diagram for vtkContainer:

[legend]Collaboration diagram for vtkContainer:

[legend]List of all members.

---

Detailed Description

An abstract container object for objects.

Author:

Sean McInerney

Version:

Revision

1.10

Date:

Date

2004/06/03 18:58:28

Definition at line 36 of file vtkContainer.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkContainer, vtkExtensionsObject)
void	PrintSelf (ostream &, vtkIndent)
virtual vtkIdType	GetSize (void) const
	Returns the number of elements in the container.
virtual int	IsEmpty (void) const
	Returns true if the container is empty.
virtual vtkIdType	GetMaxSize (void) const
	Returns the maximum size of the container.
virtual void	Clear (void)=0
	Erase ALL elements in the container.
virtual int	Swap (vtkContainer *container)=0
	Swaps elements of this object with those of the specified container.
virtual vtkIterator *	CreateIterator (void)=0
	Create an iterator.
Data Access Methods
virtual vtkObjectBase *	Front (void) const
	Get a read/write pointer to the first object in the container.
virtual vtkObjectBase *	Back (void) const
	Get a read/write pointer to the last object in the container.
Protected Member Functions
	vtkContainer (void)
	~vtkContainer ()

---

Constructor & Destructor Documentation

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

Definition at line 82 of file vtkContainer.h.

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

Definition at line 83 of file vtkContainer.h.

---

Member Function Documentation

virtual vtkObjectBase* vtkContainer::Back (  void   )  const [virtual]

Get a read/write pointer to the last object in the container. Returns: null if the container is empty, otherwise returns a pointer to an object. Reimplemented in vtkDataSetMap, vtkExtensionsObjectHashMap, vtkExtensionsObjectMap, vtkExtensionsObjectQueue, vtkExtensionsObjectSet, vtkExtensionsObjectVector, vtkObjectBaseHashMap, vtkObjectBaseMap, vtkObjectBaseQueue, vtkObjectBaseSet, vtkObjectBaseVector, vtkObjectHashMap, vtkObjectMap, vtkObjectQueue, vtkObjectSet, vtkObjectVector, vtkPolyDataMap, vtkPaletteElementHashMap, vtkPaletteElementMap, vtkPaletteHashMap, and vtkPaletteMap. Referenced by vtkObjectBaseStack::Top().

virtual void vtkContainer::Clear (  void   )  [pure virtual]

Erase ALL elements in the container. Implemented in vtkObjectBaseHashMap, vtkObjectBaseMap, vtkObjectBasePriorityQueue, vtkObjectBaseQueue, vtkObjectBaseSet, vtkObjectBaseStack, and vtkObjectBaseVector.

virtual vtkIterator* vtkContainer::CreateIterator (  void   )  [pure virtual]

Create an iterator. Implemented in vtkAbstractMap, vtkAbstractSequence, vtkExtensionsObjectHashMap, vtkExtensionsObjectMap, vtkExtensionsObjectPriorityQueue, vtkExtensionsObjectQueue, vtkExtensionsObjectSet, vtkExtensionsObjectStack, vtkExtensionsObjectVector, vtkObjectBaseHashMap, vtkObjectBaseMap, vtkObjectBasePriorityQueue, vtkObjectBaseQueue, vtkObjectBaseSet, vtkObjectBaseStack, vtkObjectBaseVector, vtkObjectHashMap, vtkObjectMap, vtkObjectPriorityQueue, vtkObjectQueue, vtkObjectSet, vtkObjectStack, vtkObjectVector, vtkPaletteElementHashMap, vtkPaletteElementMap, vtkPaletteHashMap, and vtkPaletteMap.

virtual vtkObjectBase* vtkContainer::Front (  void   )  const [virtual]

Get a read/write pointer to the first object in the container. Returns: null if the container is empty, otherwise returns a pointer to an object. Reimplemented in vtkDataSetMap, vtkExtensionsObjectHashMap, vtkExtensionsObjectMap, vtkExtensionsObjectQueue, vtkExtensionsObjectSet, vtkExtensionsObjectVector, vtkObjectBaseHashMap, vtkObjectBaseMap, vtkObjectBaseQueue, vtkObjectBaseSet, vtkObjectBaseVector, vtkObjectHashMap, vtkObjectMap, vtkObjectQueue, vtkObjectSet, vtkObjectVector, vtkPolyDataMap, vtkPaletteElementHashMap, vtkPaletteElementMap, vtkPaletteHashMap, and vtkPaletteMap. Referenced by vtkObjectBasePriorityQueue::Top().

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

Returns the maximum size of the container. Reimplemented in vtkObjectBaseHashMap, vtkObjectBaseMap, vtkObjectBasePriorityQueue, vtkObjectBaseQueue, vtkObjectBaseSet, vtkObjectBaseStack, and vtkObjectBaseVector.

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

Returns the number of elements in the container. Reimplemented in vtkObjectBaseHashMap, vtkObjectBaseMap, vtkObjectBasePriorityQueue, vtkObjectBaseQueue, vtkObjectBaseSet, vtkObjectBaseStack, and vtkObjectBaseVector. Referenced by vtkAbstractSequence::Insert(), and vtkAbstractSequence::PushBack().

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

Returns true if the container is empty. Reimplemented in vtkObjectBaseHashMap, vtkObjectBaseMap, vtkObjectBasePriorityQueue, vtkObjectBaseQueue, vtkObjectBaseSet, vtkObjectBaseStack, and vtkObjectBaseVector.

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

Reimplemented from vtkExtensionsObject. Reimplemented in vtkAbstractMap, vtkAbstractSequence, and vtkObjectBaseVector.

virtual int vtkContainer::Swap (  vtkContainer *  container  )  [pure virtual]

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

vtkContainer::vtkTypeRevisionMacro (  vtkContainer  , vtkExtensionsObject  )

---

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

• vtkContainer.h

---