vtkObjectMap Class Reference

#include <vtkObjectMap.h>

Inheritance diagram for vtkObjectMap:

[legend]Collaboration diagram for vtkObjectMap:

[legend]List of all members.

---

Detailed Description

A map object for objects.

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

Author:

Sean McInerney

Version:

Revision

1.8

Date:

Date

2004/06/03 18:58:28

See also:

vtkObjectBaseMap vtkObject

Definition at line 36 of file vtkObjectMap.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkObjectMap, vtkObjectBaseMap)
virtual int	Swap (vtkObjectMap *container)
	Swaps elements of this object with those of the specified container.
vtkObject *	Find (const char *key) const
	Find the entry in the table with the given key string.
virtual int	Insert (const char *key, vtkObject *object)
	Insert an object into the table paired with a key string.
virtual const char *	FindKey (const vtkObject *object)
	Find the first key in the map associated with an object pointer.
vtkObjectMapIterator *	CreateIterator (void)
	Create an iterator.
Data Access Methods
vtkObject *	Front (void) const
	Get a read/write pointer to the first object in the container.
virtual int	Front (const char *&key, vtkObject *&object) const
	Gets the first key - object association in the map.
vtkObject *	Back (void) const
	Get a read/write pointer to the last object in the container.
virtual int	Back (const char *&key, vtkObject *&object) const
	Gets the last key - object association in the map.
Static Public Member Functions
vtkObjectMap *	New (void)
Protected Member Functions
	vtkObjectMap (void)
	~vtkObjectMap ()

---

Constructor & Destructor Documentation

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

Definition at line 124 of file vtkObjectMap.h.

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

Definition at line 125 of file vtkObjectMap.h.

---

Member Function Documentation

int vtkObjectMap::Back (  const char *&  key, vtkObject *&  object )  const [inline, virtual]

Gets the last key - object 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 167 of file vtkObjectMap.h.

vtkObject* vtkObjectMap::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 vtkObjectBaseMap. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap. Definition at line 108 of file vtkObjectMap.h.

vtkObjectMapIterator* vtkObjectMap::CreateIterator (  void   )  [virtual]

Create an iterator. Reimplemented from vtkObjectBaseMap. Reimplemented in vtkExtensionsObjectMap, vtkPaletteElementMap, and vtkPaletteMap.

vtkObject* vtkObjectMap::Find (  const char *  key  )  const [inline, virtual]

Find the entry in the table with the given key string. Parameters: key  A unique string serving as the map key. Returns: The object associated with the specified key if found or NULL if the key is removed, empty, or non-existant. Note: Covariant return type. Reimplemented from vtkObjectBaseMap. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap. Definition at line 59 of file vtkObjectMap.h.

virtual const char* vtkObjectMap::FindKey (  const vtkObject *  object  )  [inline, virtual]

Find the first key in the map associated with an object pointer. Returns: true on success, false otherwise. Definition at line 82 of file vtkObjectMap.h.

int vtkObjectMap::Front (  const char *&  key, vtkObject *&  object )  const [inline, virtual]

Gets the first key - object 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 157 of file vtkObjectMap.h.

vtkObject* vtkObjectMap::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 vtkObjectBaseMap. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap. Definition at line 92 of file vtkObjectMap.h.

virtual int vtkObjectMap::Insert (  const char *  key, vtkObject *  object )  [inline, virtual]

Insert an object into the table paired with a key string. Parameters: key  A unique string serving as the map key. object  An object to be associated with the key. Exceptions: bad_alloc  Internal use of operator new may throw. overflow_error  Thrown for requests to grow the table beyond its maximum capacity (~ 1<<31). Returns: true for successful additions to the table or false when attempting to insert empty or duplicate strings. Definition at line 74 of file vtkObjectMap.h.

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

Reimplemented from vtkObjectBaseMap. Reimplemented in vtkDataSetMap, vtkExtensionsObjectMap, vtkPolyDataMap, vtkPaletteElementMap, and vtkPaletteMap.

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

Swaps elements of this object with those of the specified container. Returns: true on success, otherwise false. Definition at line 47 of file vtkObjectMap.h. References Swap().

vtkObjectMap::vtkTypeRevisionMacro (  vtkObjectMap  , vtkObjectBaseMap  )

---

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

• vtkObjectMap.h

---