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

vtkContainer Class Reference

a base class for templated containers More...

#include <vtkContainer.h>

Inheritance diagram for vtkContainer:

Inheritance graph
[legend]
Collaboration diagram for vtkContainer:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)

Static Public Member Functions

int IsTypeOf (const char *type)
vtkContainerSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkContainer ()
virtual ~vtkContainer ()

Detailed Description

a base class for templated containers

vtkContainer is a superclass for all container classes. Since it does not provide any actuall data access methods, it is not templated, but it provides a set of method that can be used on all containers. It also provide a simple reference counting scheme.

Caveates:
Since vtkContainer and vtkAbstractList provide some pure virtual methods, each object of type container will have v-tabe.
Caveates:
For container of strings, use <const char*> as a template argument. This way you will be able to use string literals as keys or values. Key and Value types must be default constructable.
Caveates:
Each container subclass have to understand the following methods:
Caveates:
vtkIdType GetNumberOfItems();
Caveates:
Return the number of items currently held in this container. This different from GetSize which is provided for some containers. GetSize will return how many items the container can currently hold.
Caveates:
void RemoveAllItems();
Caveates:
Removes all items from the container.
See also:
vtkAbstractIterator, vtkAbstractList, vtkAbstractMap

Definition at line 60 of file vtkContainer.h.


Constructor & Destructor Documentation

vtkContainer::vtkContainer  )  [protected]
 

virtual vtkContainer::~vtkContainer  )  [protected, virtual]
 


Member Function Documentation

virtual const char* vtkContainer::GetClassName  )  [virtual]
 

int vtkContainer::IsTypeOf const char *  type  )  [static]
 

virtual int vtkContainer::IsA const char *  type  )  [virtual]
 

vtkContainer* vtkContainer::SafeDownCast vtkObject *  o  )  [static]
 


The documentation for this class was generated from the following file:
Generated on Tue May 30 12:37:05 2006 for ParaView by doxygen 1.3.5