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

vtkDataSetMap Class Reference

#include <vtkDataSetMap.h>

Inheritance diagram for vtkDataSetMap:

Inheritance graph
[legend]
Collaboration diagram for vtkDataSetMap:

Collaboration graph
[legend]
List of all members.

Detailed Description

A map object for vtkDataSet.

Calls Register when vtkDataSet objects are inserted into the map and UnRegister when the vtkDataSet object is erased.

Author:
Sean McInerney
Version:
Revision
1.7
Date:
Date
2004/06/03 18:58:28
See also:
vtkObjectMap vtkDataSet

Definition at line 37 of file vtkDataSetMap.h.

Public Member Functions

 vtkTypeRevisionMacro (vtkDataSetMap, vtkObjectMap)
virtual int Swap (vtkDataSetMap *container)
 Swaps elements of this object with those of the specified container.

virtual vtkDataSetFind (const char *key) const
 Get a pointer to a vtkDataSet object associated with a key.

virtual int Insert (const char *key, vtkDataSet *dataSet)
 Insert a pointer to dataSet associated with a key.

virtual const char * FindKey (const vtkDataSet *dataSet)
 Find the first key in the map associated with a dataSet pointer.

Data Access Methods
vtkDataSetFront (void) const
 Get a read/write pointer to the first object in the container.

virtual int Front (const char *&key, vtkDataSet *&dataSet) const
 Gets the first key - dataSet association in the map.

vtkDataSetBack (void) const
 Get a read/write pointer to the last object in the container.

virtual int Back (const char *&key, vtkDataSet *&dataSet) const
 Gets the last key - dataSet association in the map.


Static Public Member Functions

vtkDataSetMapNew (void)

Protected Member Functions

 vtkDataSetMap (void)
 ~vtkDataSetMap ()


Constructor & Destructor Documentation

vtkDataSetMap::vtkDataSetMap void   )  [inline, protected]
 

Definition at line 111 of file vtkDataSetMap.h.

vtkDataSetMap::~vtkDataSetMap  )  [inline, protected]
 

Definition at line 112 of file vtkDataSetMap.h.


Member Function Documentation

int vtkDataSetMap::Back const char *&  key,
vtkDataSet *&  dataSet
const [inline, virtual]
 

Gets the last key - dataSet association in the map.

Returns:
false if the map is empty or this iterator has not been initialized to traverse any map, otherwise true.

Definition at line 154 of file vtkDataSetMap.h.

vtkDataSet* vtkDataSetMap::Back void   )  const [inline, 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 from vtkObjectMap.

Reimplemented in vtkPolyDataMap.

Definition at line 98 of file vtkDataSetMap.h.

virtual vtkDataSet* vtkDataSetMap::Find const char *  key  )  const [inline, virtual]
 

Get a pointer to a vtkDataSet object associated with a key.

Returns:
true on success, false otherwise.
Note:
Covariant return type.

Reimplemented from vtkObjectMap.

Reimplemented in vtkPolyDataMap.

Definition at line 57 of file vtkDataSetMap.h.

virtual const char* vtkDataSetMap::FindKey const vtkDataSet dataSet  )  [inline, virtual]
 

Find the first key in the map associated with a dataSet pointer.

Returns:
true on success, false otherwise.

Definition at line 72 of file vtkDataSetMap.h.

int vtkDataSetMap::Front const char *&  key,
vtkDataSet *&  dataSet
const [inline, virtual]
 

Gets the first key - dataSet association in the map.

Returns:
false if the map is empty or this iterator has not been initialized to traverse any map, otherwise true.

Definition at line 144 of file vtkDataSetMap.h.

vtkDataSet* vtkDataSetMap::Front void   )  const [inline, 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 from vtkObjectMap.

Reimplemented in vtkPolyDataMap.

Definition at line 82 of file vtkDataSetMap.h.

virtual int vtkDataSetMap::Insert const char *  key,
vtkDataSet dataSet
[inline, virtual]
 

Insert a pointer to dataSet associated with a key.

Returns:
true on success, false otherwise.

Definition at line 64 of file vtkDataSetMap.h.

vtkDataSetMap* vtkDataSetMap::New void   )  [static]
 

Reimplemented from vtkObjectMap.

Reimplemented in vtkPolyDataMap.

virtual int vtkDataSetMap::Swap vtkDataSetMap container  )  [inline, virtual]
 

Swaps elements of this object with those of the specified container.

Returns:
true on success, otherwise false.

Definition at line 48 of file vtkDataSetMap.h.

References Swap().

vtkDataSetMap::vtkTypeRevisionMacro vtkDataSetMap  ,
vtkObjectMap 
 


The documentation for this class was generated from the following file:
Generated on Tue Aug 10 03:42:07 2004 for vtkExtensions by doxygen 1.3.7